xref: /freebsd/sys/net/ieee8023ad_lacp.c (revision c6989859ae9388eeb46a24fe88f9b8d07101c710)
1 /*	$NetBSD: ieee8023ad_lacp.c,v 1.3 2005/12/11 12:24:54 christos Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-2-Clause-NetBSD
5  *
6  * Copyright (c)2005 YAMAMOTO Takashi,
7  * Copyright (c)2008 Andrew Thompson <thompsa@FreeBSD.org>
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 
35 #include "opt_kern_tls.h"
36 #include "opt_ratelimit.h"
37 
38 #include <sys/param.h>
39 #include <sys/callout.h>
40 #include <sys/eventhandler.h>
41 #include <sys/mbuf.h>
42 #include <sys/systm.h>
43 #include <sys/malloc.h>
44 #include <sys/kernel.h> /* hz */
45 #include <sys/socket.h> /* for net/if.h */
46 #include <sys/sockio.h>
47 #include <sys/sysctl.h>
48 #include <machine/stdarg.h>
49 #include <sys/lock.h>
50 #include <sys/rwlock.h>
51 #include <sys/taskqueue.h>
52 
53 #include <net/if.h>
54 #include <net/if_var.h>
55 #include <net/if_dl.h>
56 #include <net/ethernet.h>
57 #include <net/if_media.h>
58 #include <net/if_types.h>
59 
60 #include <net/if_lagg.h>
61 #include <net/ieee8023ad_lacp.h>
62 
63 /*
64  * actor system priority and port priority.
65  * XXX should be configurable.
66  */
67 
68 #define	LACP_SYSTEM_PRIO	0x8000
69 #define	LACP_PORT_PRIO		0x8000
70 
71 const uint8_t ethermulticastaddr_slowprotocols[ETHER_ADDR_LEN] =
72     { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x02 };
73 
74 static const struct tlv_template lacp_info_tlv_template[] = {
75 	{ LACP_TYPE_ACTORINFO,
76 	    sizeof(struct tlvhdr) + sizeof(struct lacp_peerinfo) },
77 	{ LACP_TYPE_PARTNERINFO,
78 	    sizeof(struct tlvhdr) + sizeof(struct lacp_peerinfo) },
79 	{ LACP_TYPE_COLLECTORINFO,
80 	    sizeof(struct tlvhdr) + sizeof(struct lacp_collectorinfo) },
81 	{ 0, 0 },
82 };
83 
84 static const struct tlv_template marker_info_tlv_template[] = {
85 	{ MARKER_TYPE_INFO,
86 	    sizeof(struct tlvhdr) + sizeof(struct lacp_markerinfo) },
87 	{ 0, 0 },
88 };
89 
90 static const struct tlv_template marker_response_tlv_template[] = {
91 	{ MARKER_TYPE_RESPONSE,
92 	    sizeof(struct tlvhdr) + sizeof(struct lacp_markerinfo) },
93 	{ 0, 0 },
94 };
95 
96 typedef void (*lacp_timer_func_t)(struct lacp_port *);
97 
98 static void	lacp_fill_actorinfo(struct lacp_port *, struct lacp_peerinfo *);
99 static void	lacp_fill_markerinfo(struct lacp_port *,
100 		    struct lacp_markerinfo *);
101 
102 static uint64_t	lacp_aggregator_bandwidth(struct lacp_aggregator *);
103 static void	lacp_suppress_distributing(struct lacp_softc *,
104 		    struct lacp_aggregator *);
105 static void	lacp_transit_expire(void *);
106 static void	lacp_update_portmap(struct lacp_softc *);
107 static void	lacp_select_active_aggregator(struct lacp_softc *);
108 static uint16_t	lacp_compose_key(struct lacp_port *);
109 static int	tlv_check(const void *, size_t, const struct tlvhdr *,
110 		    const struct tlv_template *, boolean_t);
111 static void	lacp_tick(void *);
112 
113 static void	lacp_fill_aggregator_id(struct lacp_aggregator *,
114 		    const struct lacp_port *);
115 static void	lacp_fill_aggregator_id_peer(struct lacp_peerinfo *,
116 		    const struct lacp_peerinfo *);
117 static int	lacp_aggregator_is_compatible(const struct lacp_aggregator *,
118 		    const struct lacp_port *);
119 static int	lacp_peerinfo_is_compatible(const struct lacp_peerinfo *,
120 		    const struct lacp_peerinfo *);
121 
122 static struct lacp_aggregator *lacp_aggregator_get(struct lacp_softc *,
123 		    struct lacp_port *);
124 static void	lacp_aggregator_addref(struct lacp_softc *,
125 		    struct lacp_aggregator *);
126 static void	lacp_aggregator_delref(struct lacp_softc *,
127 		    struct lacp_aggregator *);
128 
129 /* receive machine */
130 
131 static int	lacp_pdu_input(struct lacp_port *, struct mbuf *);
132 static int	lacp_marker_input(struct lacp_port *, struct mbuf *);
133 static void	lacp_sm_rx(struct lacp_port *, const struct lacpdu *);
134 static void	lacp_sm_rx_timer(struct lacp_port *);
135 static void	lacp_sm_rx_set_expired(struct lacp_port *);
136 static void	lacp_sm_rx_update_ntt(struct lacp_port *,
137 		    const struct lacpdu *);
138 static void	lacp_sm_rx_record_pdu(struct lacp_port *,
139 		    const struct lacpdu *);
140 static void	lacp_sm_rx_update_selected(struct lacp_port *,
141 		    const struct lacpdu *);
142 static void	lacp_sm_rx_record_default(struct lacp_port *);
143 static void	lacp_sm_rx_update_default_selected(struct lacp_port *);
144 static void	lacp_sm_rx_update_selected_from_peerinfo(struct lacp_port *,
145 		    const struct lacp_peerinfo *);
146 
147 /* mux machine */
148 
149 static void	lacp_sm_mux(struct lacp_port *);
150 static void	lacp_set_mux(struct lacp_port *, enum lacp_mux_state);
151 static void	lacp_sm_mux_timer(struct lacp_port *);
152 
153 /* periodic transmit machine */
154 
155 static void	lacp_sm_ptx_update_timeout(struct lacp_port *, uint8_t);
156 static void	lacp_sm_ptx_tx_schedule(struct lacp_port *);
157 static void	lacp_sm_ptx_timer(struct lacp_port *);
158 
159 /* transmit machine */
160 
161 static void	lacp_sm_tx(struct lacp_port *);
162 static void	lacp_sm_assert_ntt(struct lacp_port *);
163 
164 static void	lacp_run_timers(struct lacp_port *);
165 static int	lacp_compare_peerinfo(const struct lacp_peerinfo *,
166 		    const struct lacp_peerinfo *);
167 static int	lacp_compare_systemid(const struct lacp_systemid *,
168 		    const struct lacp_systemid *);
169 static void	lacp_port_enable(struct lacp_port *);
170 static void	lacp_port_disable(struct lacp_port *);
171 static void	lacp_select(struct lacp_port *);
172 static void	lacp_unselect(struct lacp_port *);
173 static void	lacp_disable_collecting(struct lacp_port *);
174 static void	lacp_enable_collecting(struct lacp_port *);
175 static void	lacp_disable_distributing(struct lacp_port *);
176 static void	lacp_enable_distributing(struct lacp_port *);
177 static int	lacp_xmit_lacpdu(struct lacp_port *);
178 static int	lacp_xmit_marker(struct lacp_port *);
179 
180 /* Debugging */
181 
182 static void	lacp_dump_lacpdu(const struct lacpdu *);
183 static const char *lacp_format_partner(const struct lacp_peerinfo *, char *,
184 		    size_t);
185 static const char *lacp_format_lagid(const struct lacp_peerinfo *,
186 		    const struct lacp_peerinfo *, char *, size_t);
187 static const char *lacp_format_lagid_aggregator(const struct lacp_aggregator *,
188 		    char *, size_t);
189 static const char *lacp_format_state(uint8_t, char *, size_t);
190 static const char *lacp_format_mac(const uint8_t *, char *, size_t);
191 static const char *lacp_format_systemid(const struct lacp_systemid *, char *,
192 		    size_t);
193 static const char *lacp_format_portid(const struct lacp_portid *, char *,
194 		    size_t);
195 static void	lacp_dprintf(const struct lacp_port *, const char *, ...)
196 		    __attribute__((__format__(__printf__, 2, 3)));
197 
198 VNET_DEFINE_STATIC(int, lacp_debug);
199 #define	V_lacp_debug	VNET(lacp_debug)
200 SYSCTL_NODE(_net_link_lagg, OID_AUTO, lacp, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
201     "ieee802.3ad");
202 SYSCTL_INT(_net_link_lagg_lacp, OID_AUTO, debug, CTLFLAG_RWTUN | CTLFLAG_VNET,
203     &VNET_NAME(lacp_debug), 0, "Enable LACP debug logging (1=debug, 2=trace)");
204 
205 VNET_DEFINE_STATIC(int, lacp_default_strict_mode) = 1;
206 SYSCTL_INT(_net_link_lagg_lacp, OID_AUTO, default_strict_mode,
207     CTLFLAG_RWTUN | CTLFLAG_VNET, &VNET_NAME(lacp_default_strict_mode), 0,
208     "LACP strict protocol compliance default");
209 #define LACP_DPRINTF(a) if (V_lacp_debug & 0x01) { lacp_dprintf a ; }
210 #define LACP_TRACE(a) if (V_lacp_debug & 0x02) { lacp_dprintf(a,"%s\n",__func__); }
211 #define LACP_TPRINTF(a) if (V_lacp_debug & 0x04) { lacp_dprintf a ; }
212 
213 /*
214  * partner administration variables.
215  * XXX should be configurable.
216  */
217 
218 static const struct lacp_peerinfo lacp_partner_admin_optimistic = {
219 	.lip_systemid = { .lsi_prio = 0xffff },
220 	.lip_portid = { .lpi_prio = 0xffff },
221 	.lip_state = LACP_STATE_SYNC | LACP_STATE_AGGREGATION |
222 	    LACP_STATE_COLLECTING | LACP_STATE_DISTRIBUTING,
223 };
224 
225 static const struct lacp_peerinfo lacp_partner_admin_strict = {
226 	.lip_systemid = { .lsi_prio = 0xffff },
227 	.lip_portid = { .lpi_prio = 0xffff },
228 	.lip_state = 0,
229 };
230 
231 static const lacp_timer_func_t lacp_timer_funcs[LACP_NTIMER] = {
232 	[LACP_TIMER_CURRENT_WHILE] = lacp_sm_rx_timer,
233 	[LACP_TIMER_PERIODIC] = lacp_sm_ptx_timer,
234 	[LACP_TIMER_WAIT_WHILE] = lacp_sm_mux_timer,
235 };
236 
237 struct mbuf *
238 lacp_input(struct lagg_port *lgp, struct mbuf *m)
239 {
240 	struct lacp_port *lp = LACP_PORT(lgp);
241 	uint8_t subtype;
242 
243 	if (m->m_pkthdr.len < sizeof(struct ether_header) + sizeof(subtype)) {
244 		m_freem(m);
245 		return (NULL);
246 	}
247 
248 	m_copydata(m, sizeof(struct ether_header), sizeof(subtype), &subtype);
249 	switch (subtype) {
250 		case SLOWPROTOCOLS_SUBTYPE_LACP:
251 			lacp_pdu_input(lp, m);
252 			return (NULL);
253 
254 		case SLOWPROTOCOLS_SUBTYPE_MARKER:
255 			lacp_marker_input(lp, m);
256 			return (NULL);
257 	}
258 
259 	/* Not a subtype we are interested in */
260 	return (m);
261 }
262 
263 /*
264  * lacp_pdu_input: process lacpdu
265  */
266 static int
267 lacp_pdu_input(struct lacp_port *lp, struct mbuf *m)
268 {
269 	struct lacp_softc *lsc = lp->lp_lsc;
270 	struct lacpdu *du;
271 	int error = 0;
272 
273 	if (m->m_pkthdr.len != sizeof(*du)) {
274 		goto bad;
275 	}
276 
277 	if ((m->m_flags & M_MCAST) == 0) {
278 		goto bad;
279 	}
280 
281 	if (m->m_len < sizeof(*du)) {
282 		m = m_pullup(m, sizeof(*du));
283 		if (m == NULL) {
284 			return (ENOMEM);
285 		}
286 	}
287 
288 	du = mtod(m, struct lacpdu *);
289 
290 	if (memcmp(&du->ldu_eh.ether_dhost,
291 	    &ethermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
292 		goto bad;
293 	}
294 
295 	/*
296 	 * ignore the version for compatibility with
297 	 * the future protocol revisions.
298 	 */
299 #if 0
300 	if (du->ldu_sph.sph_version != 1) {
301 		goto bad;
302 	}
303 #endif
304 
305 	/*
306 	 * ignore tlv types for compatibility with
307 	 * the future protocol revisions.
308 	 */
309 	if (tlv_check(du, sizeof(*du), &du->ldu_tlv_actor,
310 	    lacp_info_tlv_template, FALSE)) {
311 		goto bad;
312 	}
313 
314         if (V_lacp_debug > 0) {
315 		lacp_dprintf(lp, "lacpdu receive\n");
316 		lacp_dump_lacpdu(du);
317 	}
318 
319 	if ((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_rx_test) {
320 		LACP_TPRINTF((lp, "Dropping RX PDU\n"));
321 		goto bad;
322 	}
323 
324 	LACP_LOCK(lsc);
325 	lacp_sm_rx(lp, du);
326 	LACP_UNLOCK(lsc);
327 
328 	m_freem(m);
329 	return (error);
330 
331 bad:
332 	m_freem(m);
333 	return (EINVAL);
334 }
335 
336 static void
337 lacp_fill_actorinfo(struct lacp_port *lp, struct lacp_peerinfo *info)
338 {
339 	struct lagg_port *lgp = lp->lp_lagg;
340 	struct lagg_softc *sc = lgp->lp_softc;
341 
342 	info->lip_systemid.lsi_prio = htons(LACP_SYSTEM_PRIO);
343 	memcpy(&info->lip_systemid.lsi_mac,
344 	    IF_LLADDR(sc->sc_ifp), ETHER_ADDR_LEN);
345 	info->lip_portid.lpi_prio = htons(LACP_PORT_PRIO);
346 	info->lip_portid.lpi_portno = htons(lp->lp_ifp->if_index);
347 	info->lip_state = lp->lp_state;
348 }
349 
350 static void
351 lacp_fill_markerinfo(struct lacp_port *lp, struct lacp_markerinfo *info)
352 {
353 	struct ifnet *ifp = lp->lp_ifp;
354 
355 	/* Fill in the port index and system id (encoded as the MAC) */
356 	info->mi_rq_port = htons(ifp->if_index);
357 	memcpy(&info->mi_rq_system, lp->lp_systemid.lsi_mac, ETHER_ADDR_LEN);
358 	info->mi_rq_xid = htonl(0);
359 }
360 
361 static int
362 lacp_xmit_lacpdu(struct lacp_port *lp)
363 {
364 	struct lagg_port *lgp = lp->lp_lagg;
365 	struct mbuf *m;
366 	struct lacpdu *du;
367 	int error;
368 
369 	LACP_LOCK_ASSERT(lp->lp_lsc);
370 
371 	m = m_gethdr(M_NOWAIT, MT_DATA);
372 	if (m == NULL) {
373 		return (ENOMEM);
374 	}
375 	m->m_len = m->m_pkthdr.len = sizeof(*du);
376 
377 	du = mtod(m, struct lacpdu *);
378 	memset(du, 0, sizeof(*du));
379 
380 	memcpy(&du->ldu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
381 	    ETHER_ADDR_LEN);
382 	memcpy(&du->ldu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
383 	du->ldu_eh.ether_type = htons(ETHERTYPE_SLOW);
384 
385 	du->ldu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_LACP;
386 	du->ldu_sph.sph_version = 1;
387 
388 	TLV_SET(&du->ldu_tlv_actor, LACP_TYPE_ACTORINFO, sizeof(du->ldu_actor));
389 	du->ldu_actor = lp->lp_actor;
390 
391 	TLV_SET(&du->ldu_tlv_partner, LACP_TYPE_PARTNERINFO,
392 	    sizeof(du->ldu_partner));
393 	du->ldu_partner = lp->lp_partner;
394 
395 	TLV_SET(&du->ldu_tlv_collector, LACP_TYPE_COLLECTORINFO,
396 	    sizeof(du->ldu_collector));
397 	du->ldu_collector.lci_maxdelay = 0;
398 
399 	if (V_lacp_debug > 0) {
400 		lacp_dprintf(lp, "lacpdu transmit\n");
401 		lacp_dump_lacpdu(du);
402 	}
403 
404 	m->m_flags |= M_MCAST;
405 
406 	/*
407 	 * XXX should use higher priority queue.
408 	 * otherwise network congestion can break aggregation.
409 	 */
410 
411 	error = lagg_enqueue(lp->lp_ifp, m);
412 	return (error);
413 }
414 
415 static int
416 lacp_xmit_marker(struct lacp_port *lp)
417 {
418 	struct lagg_port *lgp = lp->lp_lagg;
419 	struct mbuf *m;
420 	struct markerdu *mdu;
421 	int error;
422 
423 	LACP_LOCK_ASSERT(lp->lp_lsc);
424 
425 	m = m_gethdr(M_NOWAIT, MT_DATA);
426 	if (m == NULL) {
427 		return (ENOMEM);
428 	}
429 	m->m_len = m->m_pkthdr.len = sizeof(*mdu);
430 
431 	mdu = mtod(m, struct markerdu *);
432 	memset(mdu, 0, sizeof(*mdu));
433 
434 	memcpy(&mdu->mdu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
435 	    ETHER_ADDR_LEN);
436 	memcpy(&mdu->mdu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
437 	mdu->mdu_eh.ether_type = htons(ETHERTYPE_SLOW);
438 
439 	mdu->mdu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_MARKER;
440 	mdu->mdu_sph.sph_version = 1;
441 
442 	/* Bump the transaction id and copy over the marker info */
443 	lp->lp_marker.mi_rq_xid = htonl(ntohl(lp->lp_marker.mi_rq_xid) + 1);
444 	TLV_SET(&mdu->mdu_tlv, MARKER_TYPE_INFO, sizeof(mdu->mdu_info));
445 	mdu->mdu_info = lp->lp_marker;
446 
447 	LACP_DPRINTF((lp, "marker transmit, port=%u, sys=%6D, id=%u\n",
448 	    ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system, ":",
449 	    ntohl(mdu->mdu_info.mi_rq_xid)));
450 
451 	m->m_flags |= M_MCAST;
452 	error = lagg_enqueue(lp->lp_ifp, m);
453 	return (error);
454 }
455 
456 void
457 lacp_linkstate(struct lagg_port *lgp)
458 {
459 	struct lacp_port *lp = LACP_PORT(lgp);
460 	struct lacp_softc *lsc = lp->lp_lsc;
461 	struct ifnet *ifp = lgp->lp_ifp;
462 	struct ifmediareq ifmr;
463 	int error = 0;
464 	u_int media;
465 	uint8_t old_state;
466 	uint16_t old_key;
467 
468 	bzero((char *)&ifmr, sizeof(ifmr));
469 	error = (*ifp->if_ioctl)(ifp, SIOCGIFXMEDIA, (caddr_t)&ifmr);
470 	if (error != 0) {
471 		bzero((char *)&ifmr, sizeof(ifmr));
472 		error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
473 	}
474 	if (error != 0)
475 		return;
476 
477 	LACP_LOCK(lsc);
478 	media = ifmr.ifm_active;
479 	LACP_DPRINTF((lp, "media changed 0x%x -> 0x%x, ether = %d, fdx = %d, "
480 	    "link = %d\n", lp->lp_media, media, IFM_TYPE(media) == IFM_ETHER,
481 	    (media & IFM_FDX) != 0, ifp->if_link_state == LINK_STATE_UP));
482 	old_state = lp->lp_state;
483 	old_key = lp->lp_key;
484 
485 	lp->lp_media = media;
486 	/*
487 	 * If the port is not an active full duplex Ethernet link then it can
488 	 * not be aggregated.
489 	 */
490 	if (IFM_TYPE(media) != IFM_ETHER || (media & IFM_FDX) == 0 ||
491 	    ifp->if_link_state != LINK_STATE_UP) {
492 		lacp_port_disable(lp);
493 	} else {
494 		lacp_port_enable(lp);
495 	}
496 	lp->lp_key = lacp_compose_key(lp);
497 
498 	if (old_state != lp->lp_state || old_key != lp->lp_key) {
499 		LACP_DPRINTF((lp, "-> UNSELECTED\n"));
500 		lp->lp_selected = LACP_UNSELECTED;
501 	}
502 	LACP_UNLOCK(lsc);
503 }
504 
505 static void
506 lacp_tick(void *arg)
507 {
508 	struct lacp_softc *lsc = arg;
509 	struct lacp_port *lp;
510 
511 	LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
512 		if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0)
513 			continue;
514 
515 		CURVNET_SET(lp->lp_ifp->if_vnet);
516 		lacp_run_timers(lp);
517 
518 		lacp_select(lp);
519 		lacp_sm_mux(lp);
520 		lacp_sm_tx(lp);
521 		lacp_sm_ptx_tx_schedule(lp);
522 		CURVNET_RESTORE();
523 	}
524 	callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
525 }
526 
527 int
528 lacp_port_create(struct lagg_port *lgp)
529 {
530 	struct lagg_softc *sc = lgp->lp_softc;
531 	struct lacp_softc *lsc = LACP_SOFTC(sc);
532 	struct lacp_port *lp;
533 	struct ifnet *ifp = lgp->lp_ifp;
534 	struct sockaddr_dl sdl;
535 	struct ifmultiaddr *rifma = NULL;
536 	int error;
537 
538 	link_init_sdl(ifp, (struct sockaddr *)&sdl, IFT_ETHER);
539 	sdl.sdl_alen = ETHER_ADDR_LEN;
540 
541 	bcopy(&ethermulticastaddr_slowprotocols,
542 	    LLADDR(&sdl), ETHER_ADDR_LEN);
543 	error = if_addmulti(ifp, (struct sockaddr *)&sdl, &rifma);
544 	if (error) {
545 		printf("%s: ADDMULTI failed on %s\n", __func__,
546 		    lgp->lp_ifp->if_xname);
547 		return (error);
548 	}
549 
550 	lp = malloc(sizeof(struct lacp_port),
551 	    M_DEVBUF, M_NOWAIT|M_ZERO);
552 	if (lp == NULL)
553 		return (ENOMEM);
554 
555 	LACP_LOCK(lsc);
556 	lgp->lp_psc = lp;
557 	lp->lp_ifp = ifp;
558 	lp->lp_lagg = lgp;
559 	lp->lp_lsc = lsc;
560 	lp->lp_ifma = rifma;
561 
562 	LIST_INSERT_HEAD(&lsc->lsc_ports, lp, lp_next);
563 
564 	lacp_fill_actorinfo(lp, &lp->lp_actor);
565 	lacp_fill_markerinfo(lp, &lp->lp_marker);
566 	lp->lp_state = LACP_STATE_ACTIVITY;
567 	lp->lp_aggregator = NULL;
568 	lacp_sm_rx_set_expired(lp);
569 	LACP_UNLOCK(lsc);
570 	lacp_linkstate(lgp);
571 
572 	return (0);
573 }
574 
575 void
576 lacp_port_destroy(struct lagg_port *lgp)
577 {
578 	struct lacp_port *lp = LACP_PORT(lgp);
579 	struct lacp_softc *lsc = lp->lp_lsc;
580 	int i;
581 
582 	LACP_LOCK(lsc);
583 	for (i = 0; i < LACP_NTIMER; i++) {
584 		LACP_TIMER_DISARM(lp, i);
585 	}
586 
587 	lacp_disable_collecting(lp);
588 	lacp_disable_distributing(lp);
589 	lacp_unselect(lp);
590 
591 	LIST_REMOVE(lp, lp_next);
592 	LACP_UNLOCK(lsc);
593 
594 	/* The address may have already been removed by if_purgemaddrs() */
595 	if (!lgp->lp_detaching)
596 		if_delmulti_ifma(lp->lp_ifma);
597 
598 	free(lp, M_DEVBUF);
599 }
600 
601 void
602 lacp_req(struct lagg_softc *sc, void *data)
603 {
604 	struct lacp_opreq *req = (struct lacp_opreq *)data;
605 	struct lacp_softc *lsc = LACP_SOFTC(sc);
606 	struct lacp_aggregator *la;
607 
608 	bzero(req, sizeof(struct lacp_opreq));
609 
610 	/*
611 	 * If the LACP softc is NULL, return with the opreq structure full of
612 	 * zeros.  It is normal for the softc to be NULL while the lagg is
613 	 * being destroyed.
614 	 */
615 	if (NULL == lsc)
616 		return;
617 
618 	la = lsc->lsc_active_aggregator;
619 	LACP_LOCK(lsc);
620 	if (la != NULL) {
621 		req->actor_prio = ntohs(la->la_actor.lip_systemid.lsi_prio);
622 		memcpy(&req->actor_mac, &la->la_actor.lip_systemid.lsi_mac,
623 		    ETHER_ADDR_LEN);
624 		req->actor_key = ntohs(la->la_actor.lip_key);
625 		req->actor_portprio = ntohs(la->la_actor.lip_portid.lpi_prio);
626 		req->actor_portno = ntohs(la->la_actor.lip_portid.lpi_portno);
627 		req->actor_state = la->la_actor.lip_state;
628 
629 		req->partner_prio = ntohs(la->la_partner.lip_systemid.lsi_prio);
630 		memcpy(&req->partner_mac, &la->la_partner.lip_systemid.lsi_mac,
631 		    ETHER_ADDR_LEN);
632 		req->partner_key = ntohs(la->la_partner.lip_key);
633 		req->partner_portprio = ntohs(la->la_partner.lip_portid.lpi_prio);
634 		req->partner_portno = ntohs(la->la_partner.lip_portid.lpi_portno);
635 		req->partner_state = la->la_partner.lip_state;
636 	}
637 	LACP_UNLOCK(lsc);
638 }
639 
640 void
641 lacp_portreq(struct lagg_port *lgp, void *data)
642 {
643 	struct lacp_opreq *req = (struct lacp_opreq *)data;
644 	struct lacp_port *lp = LACP_PORT(lgp);
645 	struct lacp_softc *lsc = lp->lp_lsc;
646 
647 	LACP_LOCK(lsc);
648 	req->actor_prio = ntohs(lp->lp_actor.lip_systemid.lsi_prio);
649 	memcpy(&req->actor_mac, &lp->lp_actor.lip_systemid.lsi_mac,
650 	    ETHER_ADDR_LEN);
651 	req->actor_key = ntohs(lp->lp_actor.lip_key);
652 	req->actor_portprio = ntohs(lp->lp_actor.lip_portid.lpi_prio);
653 	req->actor_portno = ntohs(lp->lp_actor.lip_portid.lpi_portno);
654 	req->actor_state = lp->lp_actor.lip_state;
655 
656 	req->partner_prio = ntohs(lp->lp_partner.lip_systemid.lsi_prio);
657 	memcpy(&req->partner_mac, &lp->lp_partner.lip_systemid.lsi_mac,
658 	    ETHER_ADDR_LEN);
659 	req->partner_key = ntohs(lp->lp_partner.lip_key);
660 	req->partner_portprio = ntohs(lp->lp_partner.lip_portid.lpi_prio);
661 	req->partner_portno = ntohs(lp->lp_partner.lip_portid.lpi_portno);
662 	req->partner_state = lp->lp_partner.lip_state;
663 	LACP_UNLOCK(lsc);
664 }
665 
666 static void
667 lacp_disable_collecting(struct lacp_port *lp)
668 {
669 	LACP_DPRINTF((lp, "collecting disabled\n"));
670 	lp->lp_state &= ~LACP_STATE_COLLECTING;
671 }
672 
673 static void
674 lacp_enable_collecting(struct lacp_port *lp)
675 {
676 	LACP_DPRINTF((lp, "collecting enabled\n"));
677 	lp->lp_state |= LACP_STATE_COLLECTING;
678 }
679 
680 static void
681 lacp_disable_distributing(struct lacp_port *lp)
682 {
683 	struct lacp_aggregator *la = lp->lp_aggregator;
684 	struct lacp_softc *lsc = lp->lp_lsc;
685 	struct lagg_softc *sc = lsc->lsc_softc;
686 	char buf[LACP_LAGIDSTR_MAX+1];
687 
688 	LACP_LOCK_ASSERT(lsc);
689 
690 	if (la == NULL || (lp->lp_state & LACP_STATE_DISTRIBUTING) == 0) {
691 		return;
692 	}
693 
694 	KASSERT(!TAILQ_EMPTY(&la->la_ports), ("no aggregator ports"));
695 	KASSERT(la->la_nports > 0, ("nports invalid (%d)", la->la_nports));
696 	KASSERT(la->la_refcnt >= la->la_nports, ("aggregator refcnt invalid"));
697 
698 	LACP_DPRINTF((lp, "disable distributing on aggregator %s, "
699 	    "nports %d -> %d\n",
700 	    lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
701 	    la->la_nports, la->la_nports - 1));
702 
703 	TAILQ_REMOVE(&la->la_ports, lp, lp_dist_q);
704 	la->la_nports--;
705 	sc->sc_active = la->la_nports;
706 
707 	if (lsc->lsc_active_aggregator == la) {
708 		lacp_suppress_distributing(lsc, la);
709 		lacp_select_active_aggregator(lsc);
710 		/* regenerate the port map, the active aggregator has changed */
711 		lacp_update_portmap(lsc);
712 	}
713 
714 	lp->lp_state &= ~LACP_STATE_DISTRIBUTING;
715 	if_link_state_change(sc->sc_ifp,
716 	    sc->sc_active ? LINK_STATE_UP : LINK_STATE_DOWN);
717 }
718 
719 static void
720 lacp_enable_distributing(struct lacp_port *lp)
721 {
722 	struct lacp_aggregator *la = lp->lp_aggregator;
723 	struct lacp_softc *lsc = lp->lp_lsc;
724 	struct lagg_softc *sc = lsc->lsc_softc;
725 	char buf[LACP_LAGIDSTR_MAX+1];
726 
727 	LACP_LOCK_ASSERT(lsc);
728 
729 	if ((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0) {
730 		return;
731 	}
732 
733 	LACP_DPRINTF((lp, "enable distributing on aggregator %s, "
734 	    "nports %d -> %d\n",
735 	    lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
736 	    la->la_nports, la->la_nports + 1));
737 
738 	KASSERT(la->la_refcnt > la->la_nports, ("aggregator refcnt invalid"));
739 	TAILQ_INSERT_HEAD(&la->la_ports, lp, lp_dist_q);
740 	la->la_nports++;
741 	sc->sc_active = la->la_nports;
742 
743 	lp->lp_state |= LACP_STATE_DISTRIBUTING;
744 
745 	if (lsc->lsc_active_aggregator == la) {
746 		lacp_suppress_distributing(lsc, la);
747 		lacp_update_portmap(lsc);
748 	} else
749 		/* try to become the active aggregator */
750 		lacp_select_active_aggregator(lsc);
751 
752 	if_link_state_change(sc->sc_ifp,
753 	    sc->sc_active ? LINK_STATE_UP : LINK_STATE_DOWN);
754 }
755 
756 static void
757 lacp_transit_expire(void *vp)
758 {
759 	struct lacp_softc *lsc = vp;
760 
761 	LACP_LOCK_ASSERT(lsc);
762 
763 	CURVNET_SET(lsc->lsc_softc->sc_ifp->if_vnet);
764 	LACP_TRACE(NULL);
765 	CURVNET_RESTORE();
766 
767 	lsc->lsc_suppress_distributing = FALSE;
768 }
769 
770 void
771 lacp_attach(struct lagg_softc *sc)
772 {
773 	struct lacp_softc *lsc;
774 
775 	lsc = malloc(sizeof(struct lacp_softc), M_DEVBUF, M_WAITOK | M_ZERO);
776 
777 	sc->sc_psc = lsc;
778 	lsc->lsc_softc = sc;
779 
780 	lsc->lsc_hashkey = m_ether_tcpip_hash_init();
781 	lsc->lsc_active_aggregator = NULL;
782 	lsc->lsc_strict_mode = VNET(lacp_default_strict_mode);
783 	LACP_LOCK_INIT(lsc);
784 	TAILQ_INIT(&lsc->lsc_aggregators);
785 	LIST_INIT(&lsc->lsc_ports);
786 
787 	callout_init_mtx(&lsc->lsc_transit_callout, &lsc->lsc_mtx, 0);
788 	callout_init_mtx(&lsc->lsc_callout, &lsc->lsc_mtx, 0);
789 
790 	/* if the lagg is already up then do the same */
791 	if (sc->sc_ifp->if_drv_flags & IFF_DRV_RUNNING)
792 		lacp_init(sc);
793 }
794 
795 void
796 lacp_detach(void *psc)
797 {
798 	struct lacp_softc *lsc = (struct lacp_softc *)psc;
799 
800 	KASSERT(TAILQ_EMPTY(&lsc->lsc_aggregators),
801 	    ("aggregators still active"));
802 	KASSERT(lsc->lsc_active_aggregator == NULL,
803 	    ("aggregator still attached"));
804 
805 	callout_drain(&lsc->lsc_transit_callout);
806 	callout_drain(&lsc->lsc_callout);
807 
808 	LACP_LOCK_DESTROY(lsc);
809 	free(lsc, M_DEVBUF);
810 }
811 
812 void
813 lacp_init(struct lagg_softc *sc)
814 {
815 	struct lacp_softc *lsc = LACP_SOFTC(sc);
816 
817 	LACP_LOCK(lsc);
818 	callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
819 	LACP_UNLOCK(lsc);
820 }
821 
822 void
823 lacp_stop(struct lagg_softc *sc)
824 {
825 	struct lacp_softc *lsc = LACP_SOFTC(sc);
826 
827 	LACP_LOCK(lsc);
828 	callout_stop(&lsc->lsc_transit_callout);
829 	callout_stop(&lsc->lsc_callout);
830 	LACP_UNLOCK(lsc);
831 }
832 
833 struct lagg_port *
834 lacp_select_tx_port_by_hash(struct lagg_softc *sc, uint32_t hash, uint8_t numa_domain)
835 {
836 	struct lacp_softc *lsc = LACP_SOFTC(sc);
837 	struct lacp_portmap *pm;
838 	struct lacp_port *lp;
839 	struct lacp_port **map;
840 	int count;
841 
842 	if (__predict_false(lsc->lsc_suppress_distributing)) {
843 		LACP_DPRINTF((NULL, "%s: waiting transit\n", __func__));
844 		return (NULL);
845 	}
846 
847 	pm = &lsc->lsc_pmap[lsc->lsc_activemap];
848 	if (pm->pm_count == 0) {
849 		LACP_DPRINTF((NULL, "%s: no active aggregator\n", __func__));
850 		return (NULL);
851 	}
852 
853 #ifdef NUMA
854 	if ((sc->sc_opts & LAGG_OPT_USE_NUMA) &&
855 	    pm->pm_num_dom > 1 && numa_domain < MAXMEMDOM) {
856 		count = pm->pm_numa[numa_domain].count;
857 		if (count > 0) {
858 			map = pm->pm_numa[numa_domain].map;
859 		} else {
860 			/* No ports on this domain; use global hash. */
861 			map = pm->pm_map;
862 			count = pm->pm_count;
863 		}
864 	} else
865 #endif
866 	{
867 		map = pm->pm_map;
868 		count = pm->pm_count;
869 	}
870 
871 	hash %= count;
872 	lp = map[hash];
873 
874 	KASSERT((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0,
875 	    ("aggregated port is not distributing"));
876 
877 	return (lp->lp_lagg);
878 }
879 
880 struct lagg_port *
881 lacp_select_tx_port(struct lagg_softc *sc, struct mbuf *m)
882 {
883 	struct lacp_softc *lsc = LACP_SOFTC(sc);
884 	uint32_t hash;
885 	uint8_t numa_domain;
886 
887 	if ((sc->sc_opts & LAGG_OPT_USE_FLOWID) &&
888 	    M_HASHTYPE_GET(m) != M_HASHTYPE_NONE)
889 		hash = m->m_pkthdr.flowid >> sc->flowid_shift;
890 	else
891 		hash = m_ether_tcpip_hash(sc->sc_flags, m, lsc->lsc_hashkey);
892 
893 	numa_domain = m->m_pkthdr.numa_domain;
894 	return (lacp_select_tx_port_by_hash(sc, hash, numa_domain));
895 }
896 
897 /*
898  * lacp_suppress_distributing: drop transmit packets for a while
899  * to preserve packet ordering.
900  */
901 
902 static void
903 lacp_suppress_distributing(struct lacp_softc *lsc, struct lacp_aggregator *la)
904 {
905 	struct lacp_port *lp;
906 
907 	if (lsc->lsc_active_aggregator != la) {
908 		return;
909 	}
910 
911 	LACP_TRACE(NULL);
912 
913 	lsc->lsc_suppress_distributing = TRUE;
914 
915 	/* send a marker frame down each port to verify the queues are empty */
916 	LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
917 		lp->lp_flags |= LACP_PORT_MARK;
918 		lacp_xmit_marker(lp);
919 	}
920 
921 	/* set a timeout for the marker frames */
922 	callout_reset(&lsc->lsc_transit_callout,
923 	    LACP_TRANSIT_DELAY * hz / 1000, lacp_transit_expire, lsc);
924 }
925 
926 static int
927 lacp_compare_peerinfo(const struct lacp_peerinfo *a,
928     const struct lacp_peerinfo *b)
929 {
930 	return (memcmp(a, b, offsetof(struct lacp_peerinfo, lip_state)));
931 }
932 
933 static int
934 lacp_compare_systemid(const struct lacp_systemid *a,
935     const struct lacp_systemid *b)
936 {
937 	return (memcmp(a, b, sizeof(*a)));
938 }
939 
940 #if 0	/* unused */
941 static int
942 lacp_compare_portid(const struct lacp_portid *a,
943     const struct lacp_portid *b)
944 {
945 	return (memcmp(a, b, sizeof(*a)));
946 }
947 #endif
948 
949 static uint64_t
950 lacp_aggregator_bandwidth(struct lacp_aggregator *la)
951 {
952 	struct lacp_port *lp;
953 	uint64_t speed;
954 
955 	lp = TAILQ_FIRST(&la->la_ports);
956 	if (lp == NULL) {
957 		return (0);
958 	}
959 
960 	speed = ifmedia_baudrate(lp->lp_media);
961 	speed *= la->la_nports;
962 	if (speed == 0) {
963 		LACP_DPRINTF((lp, "speed 0? media=0x%x nports=%d\n",
964 		    lp->lp_media, la->la_nports));
965 	}
966 
967 	return (speed);
968 }
969 
970 /*
971  * lacp_select_active_aggregator: select an aggregator to be used to transmit
972  * packets from lagg(4) interface.
973  */
974 
975 static void
976 lacp_select_active_aggregator(struct lacp_softc *lsc)
977 {
978 	struct lacp_aggregator *la;
979 	struct lacp_aggregator *best_la = NULL;
980 	uint64_t best_speed = 0;
981 	char buf[LACP_LAGIDSTR_MAX+1];
982 
983 	LACP_TRACE(NULL);
984 
985 	TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
986 		uint64_t speed;
987 
988 		if (la->la_nports == 0) {
989 			continue;
990 		}
991 
992 		speed = lacp_aggregator_bandwidth(la);
993 		LACP_DPRINTF((NULL, "%s, speed=%jd, nports=%d\n",
994 		    lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
995 		    speed, la->la_nports));
996 
997 		/*
998 		 * This aggregator is chosen if the partner has a better
999 		 * system priority or, the total aggregated speed is higher
1000 		 * or, it is already the chosen aggregator
1001 		 */
1002 		if ((best_la != NULL && LACP_SYS_PRI(la->la_partner) <
1003 		    LACP_SYS_PRI(best_la->la_partner)) ||
1004 		    speed > best_speed ||
1005 		    (speed == best_speed &&
1006 		    la == lsc->lsc_active_aggregator)) {
1007 			best_la = la;
1008 			best_speed = speed;
1009 		}
1010 	}
1011 
1012 	KASSERT(best_la == NULL || best_la->la_nports > 0,
1013 	    ("invalid aggregator refcnt"));
1014 	KASSERT(best_la == NULL || !TAILQ_EMPTY(&best_la->la_ports),
1015 	    ("invalid aggregator list"));
1016 
1017 	if (lsc->lsc_active_aggregator != best_la) {
1018 		LACP_DPRINTF((NULL, "active aggregator changed\n"));
1019 		LACP_DPRINTF((NULL, "old %s\n",
1020 		    lacp_format_lagid_aggregator(lsc->lsc_active_aggregator,
1021 		    buf, sizeof(buf))));
1022 	} else {
1023 		LACP_DPRINTF((NULL, "active aggregator not changed\n"));
1024 	}
1025 	LACP_DPRINTF((NULL, "new %s\n",
1026 	    lacp_format_lagid_aggregator(best_la, buf, sizeof(buf))));
1027 
1028 	if (lsc->lsc_active_aggregator != best_la) {
1029 		lsc->lsc_active_aggregator = best_la;
1030 		lacp_update_portmap(lsc);
1031 		if (best_la) {
1032 			lacp_suppress_distributing(lsc, best_la);
1033 		}
1034 	}
1035 }
1036 
1037 /*
1038  * Updated the inactive portmap array with the new list of ports and
1039  * make it live.
1040  */
1041 static void
1042 lacp_update_portmap(struct lacp_softc *lsc)
1043 {
1044 	struct lagg_softc *sc = lsc->lsc_softc;
1045 	struct lacp_aggregator *la;
1046 	struct lacp_portmap *p;
1047 	struct lacp_port *lp;
1048 	uint64_t speed;
1049 	u_int newmap;
1050 	int i;
1051 #ifdef NUMA
1052 	int count;
1053 	uint8_t domain;
1054 #endif
1055 
1056 	newmap = lsc->lsc_activemap == 0 ? 1 : 0;
1057 	p = &lsc->lsc_pmap[newmap];
1058 	la = lsc->lsc_active_aggregator;
1059 	speed = 0;
1060 	bzero(p, sizeof(struct lacp_portmap));
1061 
1062 	if (la != NULL && la->la_nports > 0) {
1063 		p->pm_count = la->la_nports;
1064 		i = 0;
1065 		TAILQ_FOREACH(lp, &la->la_ports, lp_dist_q) {
1066 			p->pm_map[i++] = lp;
1067 #ifdef NUMA
1068 			domain = lp->lp_ifp->if_numa_domain;
1069 			if (domain >= MAXMEMDOM)
1070 				continue;
1071 			count = p->pm_numa[domain].count;
1072 			p->pm_numa[domain].map[count] = lp;
1073 			p->pm_numa[domain].count++;
1074 #endif
1075 		}
1076 		KASSERT(i == p->pm_count, ("Invalid port count"));
1077 
1078 #ifdef NUMA
1079 		for (i = 0; i < MAXMEMDOM; i++) {
1080 			if (p->pm_numa[i].count != 0)
1081 				p->pm_num_dom++;
1082 		}
1083 #endif
1084 		speed = lacp_aggregator_bandwidth(la);
1085 	}
1086 	sc->sc_ifp->if_baudrate = speed;
1087 
1088 	/* switch the active portmap over */
1089 	atomic_store_rel_int(&lsc->lsc_activemap, newmap);
1090 	LACP_DPRINTF((NULL, "Set table %d with %d ports\n",
1091 		    lsc->lsc_activemap,
1092 		    lsc->lsc_pmap[lsc->lsc_activemap].pm_count));
1093 }
1094 
1095 static uint16_t
1096 lacp_compose_key(struct lacp_port *lp)
1097 {
1098 	struct lagg_port *lgp = lp->lp_lagg;
1099 	struct lagg_softc *sc = lgp->lp_softc;
1100 	u_int media = lp->lp_media;
1101 	uint16_t key;
1102 
1103 	if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0) {
1104 		/*
1105 		 * non-aggregatable links should have unique keys.
1106 		 *
1107 		 * XXX this isn't really unique as if_index is 16 bit.
1108 		 */
1109 
1110 		/* bit 0..14:	(some bits of) if_index of this port */
1111 		key = lp->lp_ifp->if_index;
1112 		/* bit 15:	1 */
1113 		key |= 0x8000;
1114 	} else {
1115 		u_int subtype = IFM_SUBTYPE(media);
1116 
1117 		KASSERT(IFM_TYPE(media) == IFM_ETHER, ("invalid media type"));
1118 		KASSERT((media & IFM_FDX) != 0, ("aggregating HDX interface"));
1119 
1120 		/* bit 0..4:	IFM_SUBTYPE modulo speed */
1121 		switch (subtype) {
1122 		case IFM_10_T:
1123 		case IFM_10_2:
1124 		case IFM_10_5:
1125 		case IFM_10_STP:
1126 		case IFM_10_FL:
1127 			key = IFM_10_T;
1128 			break;
1129 		case IFM_100_TX:
1130 		case IFM_100_FX:
1131 		case IFM_100_T4:
1132 		case IFM_100_VG:
1133 		case IFM_100_T2:
1134 		case IFM_100_T:
1135 		case IFM_100_SGMII:
1136 			key = IFM_100_TX;
1137 			break;
1138 		case IFM_1000_SX:
1139 		case IFM_1000_LX:
1140 		case IFM_1000_CX:
1141 		case IFM_1000_T:
1142 		case IFM_1000_KX:
1143 		case IFM_1000_SGMII:
1144 		case IFM_1000_CX_SGMII:
1145 			key = IFM_1000_SX;
1146 			break;
1147 		case IFM_10G_LR:
1148 		case IFM_10G_SR:
1149 		case IFM_10G_CX4:
1150 		case IFM_10G_TWINAX:
1151 		case IFM_10G_TWINAX_LONG:
1152 		case IFM_10G_LRM:
1153 		case IFM_10G_T:
1154 		case IFM_10G_KX4:
1155 		case IFM_10G_KR:
1156 		case IFM_10G_CR1:
1157 		case IFM_10G_ER:
1158 		case IFM_10G_SFI:
1159 		case IFM_10G_AOC:
1160 			key = IFM_10G_LR;
1161 			break;
1162 		case IFM_20G_KR2:
1163 			key = IFM_20G_KR2;
1164 			break;
1165 		case IFM_2500_KX:
1166 		case IFM_2500_T:
1167 		case IFM_2500_X:
1168 			key = IFM_2500_KX;
1169 			break;
1170 		case IFM_5000_T:
1171 		case IFM_5000_KR:
1172 		case IFM_5000_KR_S:
1173 		case IFM_5000_KR1:
1174 			key = IFM_5000_T;
1175 			break;
1176 		case IFM_50G_PCIE:
1177 		case IFM_50G_CR2:
1178 		case IFM_50G_KR2:
1179 		case IFM_50G_KR4:
1180 		case IFM_50G_SR2:
1181 		case IFM_50G_LR2:
1182 		case IFM_50G_LAUI2_AC:
1183 		case IFM_50G_LAUI2:
1184 		case IFM_50G_AUI2_AC:
1185 		case IFM_50G_AUI2:
1186 		case IFM_50G_CP:
1187 		case IFM_50G_SR:
1188 		case IFM_50G_LR:
1189 		case IFM_50G_FR:
1190 		case IFM_50G_KR_PAM4:
1191 		case IFM_50G_AUI1_AC:
1192 		case IFM_50G_AUI1:
1193 			key = IFM_50G_PCIE;
1194 			break;
1195 		case IFM_56G_R4:
1196 			key = IFM_56G_R4;
1197 			break;
1198 		case IFM_25G_PCIE:
1199 		case IFM_25G_CR:
1200 		case IFM_25G_KR:
1201 		case IFM_25G_SR:
1202 		case IFM_25G_LR:
1203 		case IFM_25G_ACC:
1204 		case IFM_25G_AOC:
1205 		case IFM_25G_T:
1206 		case IFM_25G_CR_S:
1207 		case IFM_25G_CR1:
1208 		case IFM_25G_KR_S:
1209 		case IFM_25G_AUI:
1210 		case IFM_25G_KR1:
1211 			key = IFM_25G_PCIE;
1212 			break;
1213 		case IFM_40G_CR4:
1214 		case IFM_40G_SR4:
1215 		case IFM_40G_LR4:
1216 		case IFM_40G_LM4:
1217 		case IFM_40G_XLPPI:
1218 		case IFM_40G_KR4:
1219 		case IFM_40G_XLAUI:
1220 		case IFM_40G_XLAUI_AC:
1221 		case IFM_40G_ER4:
1222 			key = IFM_40G_CR4;
1223 			break;
1224 		case IFM_100G_CR4:
1225 		case IFM_100G_SR4:
1226 		case IFM_100G_KR4:
1227 		case IFM_100G_LR4:
1228 		case IFM_100G_CAUI4_AC:
1229 		case IFM_100G_CAUI4:
1230 		case IFM_100G_AUI4_AC:
1231 		case IFM_100G_AUI4:
1232 		case IFM_100G_CR_PAM4:
1233 		case IFM_100G_KR_PAM4:
1234 		case IFM_100G_CP2:
1235 		case IFM_100G_SR2:
1236 		case IFM_100G_DR:
1237 		case IFM_100G_KR2_PAM4:
1238 		case IFM_100G_CAUI2_AC:
1239 		case IFM_100G_CAUI2:
1240 		case IFM_100G_AUI2_AC:
1241 		case IFM_100G_AUI2:
1242 			key = IFM_100G_CR4;
1243 			break;
1244 		case IFM_200G_CR4_PAM4:
1245 		case IFM_200G_SR4:
1246 		case IFM_200G_FR4:
1247 		case IFM_200G_LR4:
1248 		case IFM_200G_DR4:
1249 		case IFM_200G_KR4_PAM4:
1250 		case IFM_200G_AUI4_AC:
1251 		case IFM_200G_AUI4:
1252 		case IFM_200G_AUI8_AC:
1253 		case IFM_200G_AUI8:
1254 			key = IFM_200G_CR4_PAM4;
1255 			break;
1256 		case IFM_400G_FR8:
1257 		case IFM_400G_LR8:
1258 		case IFM_400G_DR4:
1259 		case IFM_400G_AUI8_AC:
1260 		case IFM_400G_AUI8:
1261 			key = IFM_400G_FR8;
1262 			break;
1263 		default:
1264 			key = subtype;
1265 			break;
1266 		}
1267 		/* bit 5..14:	(some bits of) if_index of lagg device */
1268 		key |= 0x7fe0 & ((sc->sc_ifp->if_index) << 5);
1269 		/* bit 15:	0 */
1270 	}
1271 	return (htons(key));
1272 }
1273 
1274 static void
1275 lacp_aggregator_addref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1276 {
1277 	char buf[LACP_LAGIDSTR_MAX+1];
1278 
1279 	LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1280 	    __func__,
1281 	    lacp_format_lagid(&la->la_actor, &la->la_partner,
1282 	    buf, sizeof(buf)),
1283 	    la->la_refcnt, la->la_refcnt + 1));
1284 
1285 	KASSERT(la->la_refcnt > 0, ("refcount <= 0"));
1286 	la->la_refcnt++;
1287 	KASSERT(la->la_refcnt > la->la_nports, ("invalid refcount"));
1288 }
1289 
1290 static void
1291 lacp_aggregator_delref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1292 {
1293 	char buf[LACP_LAGIDSTR_MAX+1];
1294 
1295 	LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1296 	    __func__,
1297 	    lacp_format_lagid(&la->la_actor, &la->la_partner,
1298 	    buf, sizeof(buf)),
1299 	    la->la_refcnt, la->la_refcnt - 1));
1300 
1301 	KASSERT(la->la_refcnt > la->la_nports, ("invalid refcnt"));
1302 	la->la_refcnt--;
1303 	if (la->la_refcnt > 0) {
1304 		return;
1305 	}
1306 
1307 	KASSERT(la->la_refcnt == 0, ("refcount not zero"));
1308 	KASSERT(lsc->lsc_active_aggregator != la, ("aggregator active"));
1309 
1310 	TAILQ_REMOVE(&lsc->lsc_aggregators, la, la_q);
1311 
1312 	free(la, M_DEVBUF);
1313 }
1314 
1315 /*
1316  * lacp_aggregator_get: allocate an aggregator.
1317  */
1318 
1319 static struct lacp_aggregator *
1320 lacp_aggregator_get(struct lacp_softc *lsc, struct lacp_port *lp)
1321 {
1322 	struct lacp_aggregator *la;
1323 
1324 	la = malloc(sizeof(*la), M_DEVBUF, M_NOWAIT);
1325 	if (la) {
1326 		la->la_refcnt = 1;
1327 		la->la_nports = 0;
1328 		TAILQ_INIT(&la->la_ports);
1329 		la->la_pending = 0;
1330 		TAILQ_INSERT_TAIL(&lsc->lsc_aggregators, la, la_q);
1331 	}
1332 
1333 	return (la);
1334 }
1335 
1336 /*
1337  * lacp_fill_aggregator_id: setup a newly allocated aggregator from a port.
1338  */
1339 
1340 static void
1341 lacp_fill_aggregator_id(struct lacp_aggregator *la, const struct lacp_port *lp)
1342 {
1343 	lacp_fill_aggregator_id_peer(&la->la_partner, &lp->lp_partner);
1344 	lacp_fill_aggregator_id_peer(&la->la_actor, &lp->lp_actor);
1345 
1346 	la->la_actor.lip_state = lp->lp_state & LACP_STATE_AGGREGATION;
1347 }
1348 
1349 static void
1350 lacp_fill_aggregator_id_peer(struct lacp_peerinfo *lpi_aggr,
1351     const struct lacp_peerinfo *lpi_port)
1352 {
1353 	memset(lpi_aggr, 0, sizeof(*lpi_aggr));
1354 	lpi_aggr->lip_systemid = lpi_port->lip_systemid;
1355 	lpi_aggr->lip_key = lpi_port->lip_key;
1356 }
1357 
1358 /*
1359  * lacp_aggregator_is_compatible: check if a port can join to an aggregator.
1360  */
1361 
1362 static int
1363 lacp_aggregator_is_compatible(const struct lacp_aggregator *la,
1364     const struct lacp_port *lp)
1365 {
1366 	if (!(lp->lp_state & LACP_STATE_AGGREGATION) ||
1367 	    !(lp->lp_partner.lip_state & LACP_STATE_AGGREGATION)) {
1368 		return (0);
1369 	}
1370 
1371 	if (!(la->la_actor.lip_state & LACP_STATE_AGGREGATION)) {
1372 		return (0);
1373 	}
1374 
1375 	if (!lacp_peerinfo_is_compatible(&la->la_partner, &lp->lp_partner)) {
1376 		return (0);
1377 	}
1378 
1379 	if (!lacp_peerinfo_is_compatible(&la->la_actor, &lp->lp_actor)) {
1380 		return (0);
1381 	}
1382 
1383 	return (1);
1384 }
1385 
1386 static int
1387 lacp_peerinfo_is_compatible(const struct lacp_peerinfo *a,
1388     const struct lacp_peerinfo *b)
1389 {
1390 	if (memcmp(&a->lip_systemid, &b->lip_systemid,
1391 	    sizeof(a->lip_systemid))) {
1392 		return (0);
1393 	}
1394 
1395 	if (memcmp(&a->lip_key, &b->lip_key, sizeof(a->lip_key))) {
1396 		return (0);
1397 	}
1398 
1399 	return (1);
1400 }
1401 
1402 static void
1403 lacp_port_enable(struct lacp_port *lp)
1404 {
1405 	lp->lp_state |= LACP_STATE_AGGREGATION;
1406 }
1407 
1408 static void
1409 lacp_port_disable(struct lacp_port *lp)
1410 {
1411 	lacp_set_mux(lp, LACP_MUX_DETACHED);
1412 
1413 	lp->lp_state &= ~LACP_STATE_AGGREGATION;
1414 	lp->lp_selected = LACP_UNSELECTED;
1415 	lacp_sm_rx_record_default(lp);
1416 	lp->lp_partner.lip_state &= ~LACP_STATE_AGGREGATION;
1417 	lp->lp_state &= ~LACP_STATE_EXPIRED;
1418 }
1419 
1420 /*
1421  * lacp_select: select an aggregator.  create one if necessary.
1422  */
1423 static void
1424 lacp_select(struct lacp_port *lp)
1425 {
1426 	struct lacp_softc *lsc = lp->lp_lsc;
1427 	struct lacp_aggregator *la;
1428 	char buf[LACP_LAGIDSTR_MAX+1];
1429 
1430 	if (lp->lp_aggregator) {
1431 		return;
1432 	}
1433 
1434 	/* If we haven't heard from our peer, skip this step. */
1435 	if (lp->lp_state & LACP_STATE_DEFAULTED)
1436 		return;
1437 
1438 	KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1439 	    ("timer_wait_while still active"));
1440 
1441 	LACP_DPRINTF((lp, "port lagid=%s\n",
1442 	    lacp_format_lagid(&lp->lp_actor, &lp->lp_partner,
1443 	    buf, sizeof(buf))));
1444 
1445 	TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
1446 		if (lacp_aggregator_is_compatible(la, lp)) {
1447 			break;
1448 		}
1449 	}
1450 
1451 	if (la == NULL) {
1452 		la = lacp_aggregator_get(lsc, lp);
1453 		if (la == NULL) {
1454 			LACP_DPRINTF((lp, "aggregator creation failed\n"));
1455 
1456 			/*
1457 			 * will retry on the next tick.
1458 			 */
1459 
1460 			return;
1461 		}
1462 		lacp_fill_aggregator_id(la, lp);
1463 		LACP_DPRINTF((lp, "aggregator created\n"));
1464 	} else {
1465 		LACP_DPRINTF((lp, "compatible aggregator found\n"));
1466 		if (la->la_refcnt == LACP_MAX_PORTS)
1467 			return;
1468 		lacp_aggregator_addref(lsc, la);
1469 	}
1470 
1471 	LACP_DPRINTF((lp, "aggregator lagid=%s\n",
1472 	    lacp_format_lagid(&la->la_actor, &la->la_partner,
1473 	    buf, sizeof(buf))));
1474 
1475 	lp->lp_aggregator = la;
1476 	lp->lp_selected = LACP_SELECTED;
1477 }
1478 
1479 /*
1480  * lacp_unselect: finish unselect/detach process.
1481  */
1482 
1483 static void
1484 lacp_unselect(struct lacp_port *lp)
1485 {
1486 	struct lacp_softc *lsc = lp->lp_lsc;
1487 	struct lacp_aggregator *la = lp->lp_aggregator;
1488 
1489 	KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1490 	    ("timer_wait_while still active"));
1491 
1492 	if (la == NULL) {
1493 		return;
1494 	}
1495 
1496 	lp->lp_aggregator = NULL;
1497 	lacp_aggregator_delref(lsc, la);
1498 }
1499 
1500 /* mux machine */
1501 
1502 static void
1503 lacp_sm_mux(struct lacp_port *lp)
1504 {
1505 	struct lagg_port *lgp = lp->lp_lagg;
1506 	struct lagg_softc *sc = lgp->lp_softc;
1507 	enum lacp_mux_state new_state;
1508 	boolean_t p_sync =
1509 		    (lp->lp_partner.lip_state & LACP_STATE_SYNC) != 0;
1510 	boolean_t p_collecting =
1511 	    (lp->lp_partner.lip_state & LACP_STATE_COLLECTING) != 0;
1512 	enum lacp_selected selected = lp->lp_selected;
1513 	struct lacp_aggregator *la;
1514 
1515 	if (V_lacp_debug > 1)
1516 		lacp_dprintf(lp, "%s: state= 0x%x, selected= 0x%x, "
1517 		    "p_sync= 0x%x, p_collecting= 0x%x\n", __func__,
1518 		    lp->lp_mux_state, selected, p_sync, p_collecting);
1519 
1520 re_eval:
1521 	la = lp->lp_aggregator;
1522 	KASSERT(lp->lp_mux_state == LACP_MUX_DETACHED || la != NULL,
1523 	    ("MUX not detached"));
1524 	new_state = lp->lp_mux_state;
1525 	switch (lp->lp_mux_state) {
1526 	case LACP_MUX_DETACHED:
1527 		if (selected != LACP_UNSELECTED) {
1528 			new_state = LACP_MUX_WAITING;
1529 		}
1530 		break;
1531 	case LACP_MUX_WAITING:
1532 		KASSERT(la->la_pending > 0 ||
1533 		    !LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1534 		    ("timer_wait_while still active"));
1535 		if (selected == LACP_SELECTED && la->la_pending == 0) {
1536 			new_state = LACP_MUX_ATTACHED;
1537 		} else if (selected == LACP_UNSELECTED) {
1538 			new_state = LACP_MUX_DETACHED;
1539 		}
1540 		break;
1541 	case LACP_MUX_ATTACHED:
1542 		if (selected == LACP_SELECTED && p_sync) {
1543 			new_state = LACP_MUX_COLLECTING;
1544 		} else if (selected != LACP_SELECTED) {
1545 			new_state = LACP_MUX_DETACHED;
1546 		}
1547 		break;
1548 	case LACP_MUX_COLLECTING:
1549 		if (selected == LACP_SELECTED && p_sync && p_collecting) {
1550 			new_state = LACP_MUX_DISTRIBUTING;
1551 		} else if (selected != LACP_SELECTED || !p_sync) {
1552 			new_state = LACP_MUX_ATTACHED;
1553 		}
1554 		break;
1555 	case LACP_MUX_DISTRIBUTING:
1556 		if (selected != LACP_SELECTED || !p_sync || !p_collecting) {
1557 			new_state = LACP_MUX_COLLECTING;
1558 			lacp_dprintf(lp, "Interface stopped DISTRIBUTING, possible flapping\n");
1559 			sc->sc_flapping++;
1560 		}
1561 		break;
1562 	default:
1563 		panic("%s: unknown state", __func__);
1564 	}
1565 
1566 	if (lp->lp_mux_state == new_state) {
1567 		return;
1568 	}
1569 
1570 	lacp_set_mux(lp, new_state);
1571 	goto re_eval;
1572 }
1573 
1574 static void
1575 lacp_set_mux(struct lacp_port *lp, enum lacp_mux_state new_state)
1576 {
1577 	struct lacp_aggregator *la = lp->lp_aggregator;
1578 
1579 	if (lp->lp_mux_state == new_state) {
1580 		return;
1581 	}
1582 
1583 	switch (new_state) {
1584 	case LACP_MUX_DETACHED:
1585 		lp->lp_state &= ~LACP_STATE_SYNC;
1586 		lacp_disable_distributing(lp);
1587 		lacp_disable_collecting(lp);
1588 		lacp_sm_assert_ntt(lp);
1589 		/* cancel timer */
1590 		if (LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE)) {
1591 			KASSERT(la->la_pending > 0,
1592 			    ("timer_wait_while not active"));
1593 			la->la_pending--;
1594 		}
1595 		LACP_TIMER_DISARM(lp, LACP_TIMER_WAIT_WHILE);
1596 		lacp_unselect(lp);
1597 		break;
1598 	case LACP_MUX_WAITING:
1599 		LACP_TIMER_ARM(lp, LACP_TIMER_WAIT_WHILE,
1600 		    LACP_AGGREGATE_WAIT_TIME);
1601 		la->la_pending++;
1602 		break;
1603 	case LACP_MUX_ATTACHED:
1604 		lp->lp_state |= LACP_STATE_SYNC;
1605 		lacp_disable_collecting(lp);
1606 		lacp_sm_assert_ntt(lp);
1607 		break;
1608 	case LACP_MUX_COLLECTING:
1609 		lacp_enable_collecting(lp);
1610 		lacp_disable_distributing(lp);
1611 		lacp_sm_assert_ntt(lp);
1612 		break;
1613 	case LACP_MUX_DISTRIBUTING:
1614 		lacp_enable_distributing(lp);
1615 		break;
1616 	default:
1617 		panic("%s: unknown state", __func__);
1618 	}
1619 
1620 	LACP_DPRINTF((lp, "mux_state %d -> %d\n", lp->lp_mux_state, new_state));
1621 
1622 	lp->lp_mux_state = new_state;
1623 }
1624 
1625 static void
1626 lacp_sm_mux_timer(struct lacp_port *lp)
1627 {
1628 	struct lacp_aggregator *la = lp->lp_aggregator;
1629 	char buf[LACP_LAGIDSTR_MAX+1];
1630 
1631 	KASSERT(la->la_pending > 0, ("no pending event"));
1632 
1633 	LACP_DPRINTF((lp, "%s: aggregator %s, pending %d -> %d\n", __func__,
1634 	    lacp_format_lagid(&la->la_actor, &la->la_partner,
1635 	    buf, sizeof(buf)),
1636 	    la->la_pending, la->la_pending - 1));
1637 
1638 	la->la_pending--;
1639 }
1640 
1641 /* periodic transmit machine */
1642 
1643 static void
1644 lacp_sm_ptx_update_timeout(struct lacp_port *lp, uint8_t oldpstate)
1645 {
1646 	if (LACP_STATE_EQ(oldpstate, lp->lp_partner.lip_state,
1647 	    LACP_STATE_TIMEOUT)) {
1648 		return;
1649 	}
1650 
1651 	LACP_DPRINTF((lp, "partner timeout changed\n"));
1652 
1653 	/*
1654 	 * FAST_PERIODIC -> SLOW_PERIODIC
1655 	 * or
1656 	 * SLOW_PERIODIC (-> PERIODIC_TX) -> FAST_PERIODIC
1657 	 *
1658 	 * let lacp_sm_ptx_tx_schedule to update timeout.
1659 	 */
1660 
1661 	LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1662 
1663 	/*
1664 	 * if timeout has been shortened, assert NTT.
1665 	 */
1666 
1667 	if ((lp->lp_partner.lip_state & LACP_STATE_TIMEOUT)) {
1668 		lacp_sm_assert_ntt(lp);
1669 	}
1670 }
1671 
1672 static void
1673 lacp_sm_ptx_tx_schedule(struct lacp_port *lp)
1674 {
1675 	int timeout;
1676 
1677 	if (!(lp->lp_state & LACP_STATE_ACTIVITY) &&
1678 	    !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY)) {
1679 		/*
1680 		 * NO_PERIODIC
1681 		 */
1682 
1683 		LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1684 		return;
1685 	}
1686 
1687 	if (LACP_TIMER_ISARMED(lp, LACP_TIMER_PERIODIC)) {
1688 		return;
1689 	}
1690 
1691 	timeout = (lp->lp_partner.lip_state & LACP_STATE_TIMEOUT) ?
1692 	    LACP_FAST_PERIODIC_TIME : LACP_SLOW_PERIODIC_TIME;
1693 
1694 	LACP_TIMER_ARM(lp, LACP_TIMER_PERIODIC, timeout);
1695 }
1696 
1697 static void
1698 lacp_sm_ptx_timer(struct lacp_port *lp)
1699 {
1700 	lacp_sm_assert_ntt(lp);
1701 }
1702 
1703 static void
1704 lacp_sm_rx(struct lacp_port *lp, const struct lacpdu *du)
1705 {
1706 	int timeout;
1707 
1708 	/*
1709 	 * check LACP_DISABLED first
1710 	 */
1711 
1712 	if (!(lp->lp_state & LACP_STATE_AGGREGATION)) {
1713 		return;
1714 	}
1715 
1716 	/*
1717 	 * check loopback condition.
1718 	 */
1719 
1720 	if (!lacp_compare_systemid(&du->ldu_actor.lip_systemid,
1721 	    &lp->lp_actor.lip_systemid)) {
1722 		return;
1723 	}
1724 
1725 	/*
1726 	 * EXPIRED, DEFAULTED, CURRENT -> CURRENT
1727 	 */
1728 
1729 	lacp_sm_rx_update_selected(lp, du);
1730 	lacp_sm_rx_update_ntt(lp, du);
1731 	lacp_sm_rx_record_pdu(lp, du);
1732 
1733 	timeout = (lp->lp_state & LACP_STATE_TIMEOUT) ?
1734 	    LACP_SHORT_TIMEOUT_TIME : LACP_LONG_TIMEOUT_TIME;
1735 	LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, timeout);
1736 
1737 	lp->lp_state &= ~LACP_STATE_EXPIRED;
1738 
1739 	/*
1740 	 * kick transmit machine without waiting the next tick.
1741 	 */
1742 
1743 	lacp_sm_tx(lp);
1744 }
1745 
1746 static void
1747 lacp_sm_rx_set_expired(struct lacp_port *lp)
1748 {
1749 	lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1750 	lp->lp_partner.lip_state |= LACP_STATE_TIMEOUT;
1751 	LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, LACP_SHORT_TIMEOUT_TIME);
1752 	lp->lp_state |= LACP_STATE_EXPIRED;
1753 }
1754 
1755 static void
1756 lacp_sm_rx_timer(struct lacp_port *lp)
1757 {
1758 	if ((lp->lp_state & LACP_STATE_EXPIRED) == 0) {
1759 		/* CURRENT -> EXPIRED */
1760 		LACP_DPRINTF((lp, "%s: CURRENT -> EXPIRED\n", __func__));
1761 		lacp_sm_rx_set_expired(lp);
1762 	} else {
1763 		/* EXPIRED -> DEFAULTED */
1764 		LACP_DPRINTF((lp, "%s: EXPIRED -> DEFAULTED\n", __func__));
1765 		lacp_sm_rx_update_default_selected(lp);
1766 		lacp_sm_rx_record_default(lp);
1767 		lp->lp_state &= ~LACP_STATE_EXPIRED;
1768 	}
1769 }
1770 
1771 static void
1772 lacp_sm_rx_record_pdu(struct lacp_port *lp, const struct lacpdu *du)
1773 {
1774 	boolean_t active;
1775 	uint8_t oldpstate;
1776 	char buf[LACP_STATESTR_MAX+1];
1777 
1778 	LACP_TRACE(lp);
1779 
1780 	oldpstate = lp->lp_partner.lip_state;
1781 
1782 	active = (du->ldu_actor.lip_state & LACP_STATE_ACTIVITY)
1783 	    || ((lp->lp_state & LACP_STATE_ACTIVITY) &&
1784 	    (du->ldu_partner.lip_state & LACP_STATE_ACTIVITY));
1785 
1786 	lp->lp_partner = du->ldu_actor;
1787 	if (active &&
1788 	    ((LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1789 	    LACP_STATE_AGGREGATION) &&
1790 	    !lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner))
1791 	    || (du->ldu_partner.lip_state & LACP_STATE_AGGREGATION) == 0)) {
1792 		/*
1793 		 * XXX Maintain legacy behavior of leaving the
1794 		 * LACP_STATE_SYNC bit unchanged from the partner's
1795 		 * advertisement if lsc_strict_mode is false.
1796 		 * TODO: We should re-examine the concept of the "strict mode"
1797 		 * to ensure it makes sense to maintain a non-strict mode.
1798 		 */
1799 		if (lp->lp_lsc->lsc_strict_mode)
1800 			lp->lp_partner.lip_state |= LACP_STATE_SYNC;
1801 	} else {
1802 		lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1803 	}
1804 
1805 	lp->lp_state &= ~LACP_STATE_DEFAULTED;
1806 
1807 	if (oldpstate != lp->lp_partner.lip_state) {
1808 		LACP_DPRINTF((lp, "old pstate %s\n",
1809 		    lacp_format_state(oldpstate, buf, sizeof(buf))));
1810 		LACP_DPRINTF((lp, "new pstate %s\n",
1811 		    lacp_format_state(lp->lp_partner.lip_state, buf,
1812 		    sizeof(buf))));
1813 	}
1814 
1815 	lacp_sm_ptx_update_timeout(lp, oldpstate);
1816 }
1817 
1818 static void
1819 lacp_sm_rx_update_ntt(struct lacp_port *lp, const struct lacpdu *du)
1820 {
1821 
1822 	LACP_TRACE(lp);
1823 
1824 	if (lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner) ||
1825 	    !LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1826 	    LACP_STATE_ACTIVITY | LACP_STATE_SYNC | LACP_STATE_AGGREGATION)) {
1827 		LACP_DPRINTF((lp, "%s: assert ntt\n", __func__));
1828 		lacp_sm_assert_ntt(lp);
1829 	}
1830 }
1831 
1832 static void
1833 lacp_sm_rx_record_default(struct lacp_port *lp)
1834 {
1835 	uint8_t oldpstate;
1836 
1837 	LACP_TRACE(lp);
1838 
1839 	oldpstate = lp->lp_partner.lip_state;
1840 	if (lp->lp_lsc->lsc_strict_mode)
1841 		lp->lp_partner = lacp_partner_admin_strict;
1842 	else
1843 		lp->lp_partner = lacp_partner_admin_optimistic;
1844 	lp->lp_state |= LACP_STATE_DEFAULTED;
1845 	lacp_sm_ptx_update_timeout(lp, oldpstate);
1846 }
1847 
1848 static void
1849 lacp_sm_rx_update_selected_from_peerinfo(struct lacp_port *lp,
1850     const struct lacp_peerinfo *info)
1851 {
1852 
1853 	LACP_TRACE(lp);
1854 
1855 	if (lacp_compare_peerinfo(&lp->lp_partner, info) ||
1856 	    !LACP_STATE_EQ(lp->lp_partner.lip_state, info->lip_state,
1857 	    LACP_STATE_AGGREGATION)) {
1858 		lp->lp_selected = LACP_UNSELECTED;
1859 		/* mux machine will clean up lp->lp_aggregator */
1860 	}
1861 }
1862 
1863 static void
1864 lacp_sm_rx_update_selected(struct lacp_port *lp, const struct lacpdu *du)
1865 {
1866 
1867 	LACP_TRACE(lp);
1868 
1869 	lacp_sm_rx_update_selected_from_peerinfo(lp, &du->ldu_actor);
1870 }
1871 
1872 static void
1873 lacp_sm_rx_update_default_selected(struct lacp_port *lp)
1874 {
1875 
1876 	LACP_TRACE(lp);
1877 
1878 	if (lp->lp_lsc->lsc_strict_mode)
1879 		lacp_sm_rx_update_selected_from_peerinfo(lp,
1880 		    &lacp_partner_admin_strict);
1881 	else
1882 		lacp_sm_rx_update_selected_from_peerinfo(lp,
1883 		    &lacp_partner_admin_optimistic);
1884 }
1885 
1886 /* transmit machine */
1887 
1888 static void
1889 lacp_sm_tx(struct lacp_port *lp)
1890 {
1891 	int error = 0;
1892 
1893 	if (!(lp->lp_state & LACP_STATE_AGGREGATION)
1894 #if 1
1895 	    || (!(lp->lp_state & LACP_STATE_ACTIVITY)
1896 	    && !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY))
1897 #endif
1898 	    ) {
1899 		lp->lp_flags &= ~LACP_PORT_NTT;
1900 	}
1901 
1902 	if (!(lp->lp_flags & LACP_PORT_NTT)) {
1903 		return;
1904 	}
1905 
1906 	/* Rate limit to 3 PDUs per LACP_FAST_PERIODIC_TIME */
1907 	if (ppsratecheck(&lp->lp_last_lacpdu, &lp->lp_lacpdu_sent,
1908 		    (3 / LACP_FAST_PERIODIC_TIME)) == 0) {
1909 		LACP_DPRINTF((lp, "rate limited pdu\n"));
1910 		return;
1911 	}
1912 
1913 	if (((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_tx_test) == 0) {
1914 		error = lacp_xmit_lacpdu(lp);
1915 	} else {
1916 		LACP_TPRINTF((lp, "Dropping TX PDU\n"));
1917 	}
1918 
1919 	if (error == 0) {
1920 		lp->lp_flags &= ~LACP_PORT_NTT;
1921 	} else {
1922 		LACP_DPRINTF((lp, "lacpdu transmit failure, error %d\n",
1923 		    error));
1924 	}
1925 }
1926 
1927 static void
1928 lacp_sm_assert_ntt(struct lacp_port *lp)
1929 {
1930 
1931 	lp->lp_flags |= LACP_PORT_NTT;
1932 }
1933 
1934 static void
1935 lacp_run_timers(struct lacp_port *lp)
1936 {
1937 	int i;
1938 
1939 	for (i = 0; i < LACP_NTIMER; i++) {
1940 		KASSERT(lp->lp_timer[i] >= 0,
1941 		    ("invalid timer value %d", lp->lp_timer[i]));
1942 		if (lp->lp_timer[i] == 0) {
1943 			continue;
1944 		} else if (--lp->lp_timer[i] <= 0) {
1945 			if (lacp_timer_funcs[i]) {
1946 				(*lacp_timer_funcs[i])(lp);
1947 			}
1948 		}
1949 	}
1950 }
1951 
1952 int
1953 lacp_marker_input(struct lacp_port *lp, struct mbuf *m)
1954 {
1955 	struct lacp_softc *lsc = lp->lp_lsc;
1956 	struct lagg_port *lgp = lp->lp_lagg;
1957 	struct lacp_port *lp2;
1958 	struct markerdu *mdu;
1959 	int error = 0;
1960 	int pending = 0;
1961 
1962 	if (m->m_pkthdr.len != sizeof(*mdu)) {
1963 		goto bad;
1964 	}
1965 
1966 	if ((m->m_flags & M_MCAST) == 0) {
1967 		goto bad;
1968 	}
1969 
1970 	if (m->m_len < sizeof(*mdu)) {
1971 		m = m_pullup(m, sizeof(*mdu));
1972 		if (m == NULL) {
1973 			return (ENOMEM);
1974 		}
1975 	}
1976 
1977 	mdu = mtod(m, struct markerdu *);
1978 
1979 	if (memcmp(&mdu->mdu_eh.ether_dhost,
1980 	    &ethermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
1981 		goto bad;
1982 	}
1983 
1984 	if (mdu->mdu_sph.sph_version != 1) {
1985 		goto bad;
1986 	}
1987 
1988 	switch (mdu->mdu_tlv.tlv_type) {
1989 	case MARKER_TYPE_INFO:
1990 		if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1991 		    marker_info_tlv_template, TRUE)) {
1992 			goto bad;
1993 		}
1994 		mdu->mdu_tlv.tlv_type = MARKER_TYPE_RESPONSE;
1995 		memcpy(&mdu->mdu_eh.ether_dhost,
1996 		    &ethermulticastaddr_slowprotocols, ETHER_ADDR_LEN);
1997 		memcpy(&mdu->mdu_eh.ether_shost,
1998 		    lgp->lp_lladdr, ETHER_ADDR_LEN);
1999 		error = lagg_enqueue(lp->lp_ifp, m);
2000 		break;
2001 
2002 	case MARKER_TYPE_RESPONSE:
2003 		if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
2004 		    marker_response_tlv_template, TRUE)) {
2005 			goto bad;
2006 		}
2007 		LACP_DPRINTF((lp, "marker response, port=%u, sys=%6D, id=%u\n",
2008 		    ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system,
2009 		    ":", ntohl(mdu->mdu_info.mi_rq_xid)));
2010 
2011 		/* Verify that it is the last marker we sent out */
2012 		if (memcmp(&mdu->mdu_info, &lp->lp_marker,
2013 		    sizeof(struct lacp_markerinfo)))
2014 			goto bad;
2015 
2016 		LACP_LOCK(lsc);
2017 		lp->lp_flags &= ~LACP_PORT_MARK;
2018 
2019 		if (lsc->lsc_suppress_distributing) {
2020 			/* Check if any ports are waiting for a response */
2021 			LIST_FOREACH(lp2, &lsc->lsc_ports, lp_next) {
2022 				if (lp2->lp_flags & LACP_PORT_MARK) {
2023 					pending = 1;
2024 					break;
2025 				}
2026 			}
2027 
2028 			if (pending == 0) {
2029 				/* All interface queues are clear */
2030 				LACP_DPRINTF((NULL, "queue flush complete\n"));
2031 				lsc->lsc_suppress_distributing = FALSE;
2032 			}
2033 		}
2034 		LACP_UNLOCK(lsc);
2035 		m_freem(m);
2036 		break;
2037 
2038 	default:
2039 		goto bad;
2040 	}
2041 
2042 	return (error);
2043 
2044 bad:
2045 	LACP_DPRINTF((lp, "bad marker frame\n"));
2046 	m_freem(m);
2047 	return (EINVAL);
2048 }
2049 
2050 static int
2051 tlv_check(const void *p, size_t size, const struct tlvhdr *tlv,
2052     const struct tlv_template *tmpl, boolean_t check_type)
2053 {
2054 	while (/* CONSTCOND */ 1) {
2055 		if ((const char *)tlv - (const char *)p + sizeof(*tlv) > size) {
2056 			return (EINVAL);
2057 		}
2058 		if ((check_type && tlv->tlv_type != tmpl->tmpl_type) ||
2059 		    tlv->tlv_length != tmpl->tmpl_length) {
2060 			return (EINVAL);
2061 		}
2062 		if (tmpl->tmpl_type == 0) {
2063 			break;
2064 		}
2065 		tlv = (const struct tlvhdr *)
2066 		    ((const char *)tlv + tlv->tlv_length);
2067 		tmpl++;
2068 	}
2069 
2070 	return (0);
2071 }
2072 
2073 /* Debugging */
2074 const char *
2075 lacp_format_mac(const uint8_t *mac, char *buf, size_t buflen)
2076 {
2077 	snprintf(buf, buflen, "%02X-%02X-%02X-%02X-%02X-%02X",
2078 	    (int)mac[0],
2079 	    (int)mac[1],
2080 	    (int)mac[2],
2081 	    (int)mac[3],
2082 	    (int)mac[4],
2083 	    (int)mac[5]);
2084 
2085 	return (buf);
2086 }
2087 
2088 const char *
2089 lacp_format_systemid(const struct lacp_systemid *sysid,
2090     char *buf, size_t buflen)
2091 {
2092 	char macbuf[LACP_MACSTR_MAX+1];
2093 
2094 	snprintf(buf, buflen, "%04X,%s",
2095 	    ntohs(sysid->lsi_prio),
2096 	    lacp_format_mac(sysid->lsi_mac, macbuf, sizeof(macbuf)));
2097 
2098 	return (buf);
2099 }
2100 
2101 const char *
2102 lacp_format_portid(const struct lacp_portid *portid, char *buf, size_t buflen)
2103 {
2104 	snprintf(buf, buflen, "%04X,%04X",
2105 	    ntohs(portid->lpi_prio),
2106 	    ntohs(portid->lpi_portno));
2107 
2108 	return (buf);
2109 }
2110 
2111 const char *
2112 lacp_format_partner(const struct lacp_peerinfo *peer, char *buf, size_t buflen)
2113 {
2114 	char sysid[LACP_SYSTEMIDSTR_MAX+1];
2115 	char portid[LACP_PORTIDSTR_MAX+1];
2116 
2117 	snprintf(buf, buflen, "(%s,%04X,%s)",
2118 	    lacp_format_systemid(&peer->lip_systemid, sysid, sizeof(sysid)),
2119 	    ntohs(peer->lip_key),
2120 	    lacp_format_portid(&peer->lip_portid, portid, sizeof(portid)));
2121 
2122 	return (buf);
2123 }
2124 
2125 const char *
2126 lacp_format_lagid(const struct lacp_peerinfo *a,
2127     const struct lacp_peerinfo *b, char *buf, size_t buflen)
2128 {
2129 	char astr[LACP_PARTNERSTR_MAX+1];
2130 	char bstr[LACP_PARTNERSTR_MAX+1];
2131 
2132 #if 0
2133 	/*
2134 	 * there's a convention to display small numbered peer
2135 	 * in the left.
2136 	 */
2137 
2138 	if (lacp_compare_peerinfo(a, b) > 0) {
2139 		const struct lacp_peerinfo *t;
2140 
2141 		t = a;
2142 		a = b;
2143 		b = t;
2144 	}
2145 #endif
2146 
2147 	snprintf(buf, buflen, "[%s,%s]",
2148 	    lacp_format_partner(a, astr, sizeof(astr)),
2149 	    lacp_format_partner(b, bstr, sizeof(bstr)));
2150 
2151 	return (buf);
2152 }
2153 
2154 const char *
2155 lacp_format_lagid_aggregator(const struct lacp_aggregator *la,
2156     char *buf, size_t buflen)
2157 {
2158 	if (la == NULL) {
2159 		return ("(none)");
2160 	}
2161 
2162 	return (lacp_format_lagid(&la->la_actor, &la->la_partner, buf, buflen));
2163 }
2164 
2165 const char *
2166 lacp_format_state(uint8_t state, char *buf, size_t buflen)
2167 {
2168 	snprintf(buf, buflen, "%b", state, LACP_STATE_BITS);
2169 	return (buf);
2170 }
2171 
2172 static void
2173 lacp_dump_lacpdu(const struct lacpdu *du)
2174 {
2175 	char buf[LACP_PARTNERSTR_MAX+1];
2176 	char buf2[LACP_STATESTR_MAX+1];
2177 
2178 	printf("actor=%s\n",
2179 	    lacp_format_partner(&du->ldu_actor, buf, sizeof(buf)));
2180 	printf("actor.state=%s\n",
2181 	    lacp_format_state(du->ldu_actor.lip_state, buf2, sizeof(buf2)));
2182 	printf("partner=%s\n",
2183 	    lacp_format_partner(&du->ldu_partner, buf, sizeof(buf)));
2184 	printf("partner.state=%s\n",
2185 	    lacp_format_state(du->ldu_partner.lip_state, buf2, sizeof(buf2)));
2186 
2187 	printf("maxdelay=%d\n", ntohs(du->ldu_collector.lci_maxdelay));
2188 }
2189 
2190 static void
2191 lacp_dprintf(const struct lacp_port *lp, const char *fmt, ...)
2192 {
2193 	va_list va;
2194 
2195 	if (lp) {
2196 		printf("%s: ", lp->lp_ifp->if_xname);
2197 	}
2198 
2199 	va_start(va, fmt);
2200 	vprintf(fmt, va);
2201 	va_end(va);
2202 }
2203