sys/net/ieee8023ad_lacp.c

   1 /*      $NetBSD: ieee8023ad_lacp.c,v 1.3 2005/12/11 12:24:54 christos Exp $     */
   2
   3 /*-
   4  * Copyright (c)2005 YAMAMOTO Takashi,
   5  * Copyright (c)2008 Andrew Thompson <thompsa@FreeBSD.org>
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  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.
  16  *
  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
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/callout.h>
  35 #include <sys/mbuf.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>
  43 #include <sys/lock.h>
  44 #include <sys/rwlock.h>
  45
  46 #include <net/if.h>
  47 #include <net/if_dl.h>
  48 #include <net/ethernet.h>
  49 #include <net/if_media.h>
  50 #include <net/if_types.h>
  51
  52 #include <net/if_lagg.h>
  53 #include <net/ieee8023ad_lacp.h>
  54
  55 /*
  56  * actor system priority and port priority.
  57  * XXX should be configurable.
  58  */
  59
  60 #define LACP_SYSTEM_PRIO        0x8000
  61 #define LACP_PORT_PRIO          0x8000
  62
  63 const uint8_t ethermulticastaddr_slowprotocols[ETHER_ADDR_LEN] =
  64     { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x02 };
  65
  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) },
  73         { 0, 0 },
  74 };
  75
  76 static const struct tlv_template marker_info_tlv_template[] = {
  77         { MARKER_TYPE_INFO,
  78             sizeof(struct tlvhdr) + sizeof(struct lacp_markerinfo) },
  79         { 0, 0 },
  80 };
  81
  82 static const struct tlv_template marker_response_tlv_template[] = {
  83         { MARKER_TYPE_RESPONSE,
  84             sizeof(struct tlvhdr) + sizeof(struct lacp_markerinfo) },
  85         { 0, 0 },
  86 };
  87
  88 typedef void (*lacp_timer_func_t)(struct lacp_port *);
  89
  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 *);
  93
  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 *);
 104
 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 *);
 113
 114 static struct lacp_aggregator *lacp_aggregator_get(struct lacp_softc *,
 115                     struct lacp_port *);
 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 *);
 120
 121 /* receive machine */
 122
 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 *);
 138
 139 /* mux machine */
 140
 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 *);
 144
 145 /* periodic transmit machine */
 146
 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 *);
 150
 151 /* transmit machine */
 152
 153 static void     lacp_sm_tx(struct lacp_port *);
 154 static void     lacp_sm_assert_ntt(struct lacp_port *);
 155
 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 *);
 171
 172 /* Debugging */
 173
 174 static void     lacp_dump_lacpdu(const struct lacpdu *);
 175 static const char *lacp_format_partner(const struct lacp_peerinfo *, char *,
 176                     size_t);
 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 *,
 180                     char *, size_t);
 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 *,
 184                     size_t);
 185 static const char *lacp_format_portid(const struct lacp_portid *, char *,
 186                     size_t);
 187 static void     lacp_dprintf(const struct lacp_port *, const char *, ...)
 188                     __attribute__((__format__(__printf__, 2, 3)));
 189
 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);
 195
 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 ; }
 199
 200 /*
 201  * partner administration variables.
 202  * XXX should be configurable.
 203  */
 204
 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,
 210 };
 211
 212 static const struct lacp_peerinfo lacp_partner_admin_strict = {
 213         .lip_systemid = { .lsi_prio = 0xffff },
 214         .lip_portid = { .lpi_prio = 0xffff },
 215         .lip_state = 0,
 216 };
 217
 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,
 222 };
 223
 224 struct mbuf *
 225 lacp_input(struct lagg_port *lgp, struct mbuf *m)
 226 {
 227         struct lacp_port *lp = LACP_PORT(lgp);
 228         uint8_t subtype;
 229
 230         if (m->m_pkthdr.len < sizeof(struct ether_header) + sizeof(subtype)) {
 231                 m_freem(m);
 232                 return (NULL);
 233         }
 234
 235         m_copydata(m, sizeof(struct ether_header), sizeof(subtype), &subtype);
 236         switch (subtype) {
 237                 case SLOWPROTOCOLS_SUBTYPE_LACP:
 238                         lacp_pdu_input(lp, m);
 239                         return (NULL);
 240
 241                 case SLOWPROTOCOLS_SUBTYPE_MARKER:
 242                         lacp_marker_input(lp, m);
 243                         return (NULL);
 244         }
 245
 246         /* Not a subtype we are interested in */
 247         return (m);
 248 }
 249
 250 /*
 251  * lacp_pdu_input: process lacpdu
 252  */
 253 static int
 254 lacp_pdu_input(struct lacp_port *lp, struct mbuf *m)
 255 {
 256         struct lacp_softc *lsc = lp->lp_lsc;
 257         struct lacpdu *du;
 258         int error = 0;
 259
 260         if (m->m_pkthdr.len != sizeof(*du)) {
 261                 goto bad;
 262         }
 263
 264         if ((m->m_flags & M_MCAST) == 0) {
 265                 goto bad;
 266         }
 267
 268         if (m->m_len < sizeof(*du)) {
 269                 m = m_pullup(m, sizeof(*du));
 270                 if (m == NULL) {
 271                         return (ENOMEM);
 272                 }
 273         }
 274
 275         du = mtod(m, struct lacpdu *);
 276
 277         if (memcmp(&du->ldu_eh.ether_dhost,
 278             &ethermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
 279                 goto bad;
 280         }
 281
 282         /*
 283          * ignore the version for compatibility with
 284          * the future protocol revisions.
 285          */
 286 #if 0
 287         if (du->ldu_sph.sph_version != 1) {
 288                 goto bad;
 289         }
 290 #endif
 291
 292         /*
 293          * ignore tlv types for compatibility with
 294          * the future protocol revisions.
 295          */
 296         if (tlv_check(du, sizeof(*du), &du->ldu_tlv_actor,
 297             lacp_info_tlv_template, FALSE)) {
 298                 goto bad;
 299         }
 300
 301         if (lacp_debug > 0) {
 302                 lacp_dprintf(lp, "lacpdu receive\n");
 303                 lacp_dump_lacpdu(du);
 304         }
 305
 306         if ((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_rx_test) {
 307                 LACP_TPRINTF((lp, "Dropping RX PDU\n"));
 308                 goto bad;
 309         }
 310
 311         LACP_LOCK(lsc);
 312         lacp_sm_rx(lp, du);
 313         LACP_UNLOCK(lsc);
 314
 315         m_freem(m);
 316         return (error);
 317
 318 bad:
 319         m_freem(m);
 320         return (EINVAL);
 321 }
 322
 323 static void
 324 lacp_fill_actorinfo(struct lacp_port *lp, struct lacp_peerinfo *info)
 325 {
 326         struct lagg_port *lgp = lp->lp_lagg;
 327         struct lagg_softc *sc = lgp->lp_softc;
 328
 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;
 335 }
 336
 337 static void
 338 lacp_fill_markerinfo(struct lacp_port *lp, struct lacp_markerinfo *info)
 339 {
 340         struct ifnet *ifp = lp->lp_ifp;
 341
 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);
 346 }
 347
 348 static int
 349 lacp_xmit_lacpdu(struct lacp_port *lp)
 350 {
 351         struct lagg_port *lgp = lp->lp_lagg;
 352         struct mbuf *m;
 353         struct lacpdu *du;
 354         int error;
 355
 356         LACP_LOCK_ASSERT(lp->lp_lsc);
 357
 358         m = m_gethdr(M_NOWAIT, MT_DATA);
 359         if (m == NULL) {
 360                 return (ENOMEM);
 361         }
 362         m->m_len = m->m_pkthdr.len = sizeof(*du);
 363
 364         du = mtod(m, struct lacpdu *);
 365         memset(du, 0, sizeof(*du));
 366
 367         memcpy(&du->ldu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
 368             ETHER_ADDR_LEN);
 369         memcpy(&du->ldu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
 370         du->ldu_eh.ether_type = htons(ETHERTYPE_SLOW);
 371
 372         du->ldu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_LACP;
 373         du->ldu_sph.sph_version = 1;
 374
 375         TLV_SET(&du->ldu_tlv_actor, LACP_TYPE_ACTORINFO, sizeof(du->ldu_actor));
 376         du->ldu_actor = lp->lp_actor;
 377
 378         TLV_SET(&du->ldu_tlv_partner, LACP_TYPE_PARTNERINFO,
 379             sizeof(du->ldu_partner));
 380         du->ldu_partner = lp->lp_partner;
 381
 382         TLV_SET(&du->ldu_tlv_collector, LACP_TYPE_COLLECTORINFO,
 383             sizeof(du->ldu_collector));
 384         du->ldu_collector.lci_maxdelay = 0;
 385
 386         if (lacp_debug > 0) {
 387                 lacp_dprintf(lp, "lacpdu transmit\n");
 388                 lacp_dump_lacpdu(du);
 389         }
 390
 391         m->m_flags |= M_MCAST;
 392
 393         /*
 394          * XXX should use higher priority queue.
 395          * otherwise network congestion can break aggregation.
 396          */
 397
 398         error = lagg_enqueue(lp->lp_ifp, m);
 399         return (error);
 400 }
 401
 402 static int
 403 lacp_xmit_marker(struct lacp_port *lp)
 404 {
 405         struct lagg_port *lgp = lp->lp_lagg;
 406         struct mbuf *m;
 407         struct markerdu *mdu;
 408         int error;
 409
 410         LACP_LOCK_ASSERT(lp->lp_lsc);
 411
 412         m = m_gethdr(M_NOWAIT, MT_DATA);
 413         if (m == NULL) {
 414                 return (ENOMEM);
 415         }
 416         m->m_len = m->m_pkthdr.len = sizeof(*mdu);
 417
 418         mdu = mtod(m, struct markerdu *);
 419         memset(mdu, 0, sizeof(*mdu));
 420
 421         memcpy(&mdu->mdu_eh.ether_dhost, ethermulticastaddr_slowprotocols,
 422             ETHER_ADDR_LEN);
 423         memcpy(&mdu->mdu_eh.ether_shost, lgp->lp_lladdr, ETHER_ADDR_LEN);
 424         mdu->mdu_eh.ether_type = htons(ETHERTYPE_SLOW);
 425
 426         mdu->mdu_sph.sph_subtype = SLOWPROTOCOLS_SUBTYPE_MARKER;
 427         mdu->mdu_sph.sph_version = 1;
 428
 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;
 433
 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)));
 437
 438         m->m_flags |= M_MCAST;
 439         error = lagg_enqueue(lp->lp_ifp, m);
 440         return (error);
 441 }
 442
 443 void
 444 lacp_linkstate(struct lagg_port *lgp)
 445 {
 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;
 450         int error = 0;
 451         u_int media;
 452         uint8_t old_state;
 453         uint16_t old_key;
 454
 455         bzero((char *)&ifmr, sizeof(ifmr));
 456         error = (*ifp->if_ioctl)(ifp, SIOCGIFMEDIA, (caddr_t)&ifmr);
 457         if (error != 0)
 458                 return;
 459
 460         LACP_LOCK(lsc);
 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;
 467
 468         lp->lp_media = media;
 469         /*
 470          * If the port is not an active full duplex Ethernet link then it can
 471          * not be aggregated.
 472          */
 473         if (IFM_TYPE(media) != IFM_ETHER || (media & IFM_FDX) == 0 ||
 474             ifp->if_link_state != LINK_STATE_UP) {
 475                 lacp_port_disable(lp);
 476         } else {
 477                 lacp_port_enable(lp);
 478         }
 479         lp->lp_key = lacp_compose_key(lp);
 480
 481         if (old_state != lp->lp_state || old_key != lp->lp_key) {
 482                 LACP_DPRINTF((lp, "-> UNSELECTED\n"));
 483                 lp->lp_selected = LACP_UNSELECTED;
 484         }
 485         LACP_UNLOCK(lsc);
 486 }
 487
 488 static void
 489 lacp_tick(void *arg)
 490 {
 491         struct lacp_softc *lsc = arg;
 492         struct lacp_port *lp;
 493
 494         LIST_FOREACH(lp, &lsc->lsc_ports, lp_next) {
 495                 if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0)
 496                         continue;
 497
 498                 lacp_run_timers(lp);
 499
 500                 lacp_select(lp);
 501                 lacp_sm_mux(lp);
 502                 lacp_sm_tx(lp);
 503                 lacp_sm_ptx_tx_schedule(lp);
 504         }
 505         callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
 506 }
 507
 508 int
 509 lacp_port_create(struct lagg_port *lgp)
 510 {
 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;
 517         int error;
 518
 519         boolean_t active = TRUE; /* XXX should be configurable */
 520         boolean_t fast = FALSE; /* XXX should be configurable */
 521
 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;
 528
 529         bcopy(&ethermulticastaddr_slowprotocols,
 530             LLADDR(&sdl), ETHER_ADDR_LEN);
 531         error = if_addmulti(ifp, (struct sockaddr *)&sdl, &rifma);
 532         if (error) {
 533                 printf("%s: ADDMULTI failed on %s\n", __func__, lgp->lp_ifname);
 534                 return (error);
 535         }
 536
 537         lp = malloc(sizeof(struct lacp_port),
 538             M_DEVBUF, M_NOWAIT|M_ZERO);
 539         if (lp == NULL)
 540                 return (ENOMEM);
 541
 542         LACP_LOCK(lsc);
 543         lgp->lp_psc = (caddr_t)lp;
 544         lp->lp_ifp = ifp;
 545         lp->lp_lagg = lgp;
 546         lp->lp_lsc = lsc;
 547         lp->lp_ifma = rifma;
 548
 549         LIST_INSERT_HEAD(&lsc->lsc_ports, lp, lp_next);
 550
 551         lacp_fill_actorinfo(lp, &lp->lp_actor);
 552         lacp_fill_markerinfo(lp, &lp->lp_marker);
 553         lp->lp_state =
 554             (active ? LACP_STATE_ACTIVITY : 0) |
 555             (fast ? LACP_STATE_TIMEOUT : 0);
 556         lp->lp_aggregator = NULL;
 557         lacp_sm_rx_set_expired(lp);
 558         LACP_UNLOCK(lsc);
 559         lacp_linkstate(lgp);
 560
 561         return (0);
 562 }
 563
 564 void
 565 lacp_port_destroy(struct lagg_port *lgp)
 566 {
 567         struct lacp_port *lp = LACP_PORT(lgp);
 568         struct lacp_softc *lsc = lp->lp_lsc;
 569         int i;
 570
 571         LACP_LOCK(lsc);
 572         for (i = 0; i < LACP_NTIMER; i++) {
 573                 LACP_TIMER_DISARM(lp, i);
 574         }
 575
 576         lacp_disable_collecting(lp);
 577         lacp_disable_distributing(lp);
 578         lacp_unselect(lp);
 579
 580         /* The address may have already been removed by if_purgemaddrs() */
 581         if (!lgp->lp_detaching)
 582                 if_delmulti_ifma(lp->lp_ifma);
 583
 584         LIST_REMOVE(lp, lp_next);
 585         LACP_UNLOCK(lsc);
 586         free(lp, M_DEVBUF);
 587 }
 588
 589 void
 590 lacp_req(struct lagg_softc *sc, caddr_t data)
 591 {
 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;
 595
 596         LACP_LOCK(lsc);
 597         bzero(req, sizeof(struct lacp_opreq));
 598         if (la != NULL) {
 599                 req->actor_prio = ntohs(la->la_actor.lip_systemid.lsi_prio);
 600                 memcpy(&req->actor_mac, &la->la_actor.lip_systemid.lsi_mac,
 601                     ETHER_ADDR_LEN);
 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;
 606
 607                 req->partner_prio = ntohs(la->la_partner.lip_systemid.lsi_prio);
 608                 memcpy(&req->partner_mac, &la->la_partner.lip_systemid.lsi_mac,
 609                     ETHER_ADDR_LEN);
 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;
 614         }
 615         LACP_UNLOCK(lsc);
 616 }
 617
 618 void
 619 lacp_portreq(struct lagg_port *lgp, caddr_t data)
 620 {
 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;
 624
 625         LACP_LOCK(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,
 628             ETHER_ADDR_LEN);
 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;
 633
 634         req->partner_prio = ntohs(lp->lp_partner.lip_systemid.lsi_prio);
 635         memcpy(&req->partner_mac, &lp->lp_partner.lip_systemid.lsi_mac,
 636             ETHER_ADDR_LEN);
 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;
 641         LACP_UNLOCK(lsc);
 642 }
 643
 644 static void
 645 lacp_disable_collecting(struct lacp_port *lp)
 646 {
 647         LACP_DPRINTF((lp, "collecting disabled\n"));
 648         lp->lp_state &= ~LACP_STATE_COLLECTING;
 649 }
 650
 651 static void
 652 lacp_enable_collecting(struct lacp_port *lp)
 653 {
 654         LACP_DPRINTF((lp, "collecting enabled\n"));
 655         lp->lp_state |= LACP_STATE_COLLECTING;
 656 }
 657
 658 static void
 659 lacp_disable_distributing(struct lacp_port *lp)
 660 {
 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];
 665
 666         LACP_LOCK_ASSERT(lsc);
 667
 668         if (la == NULL || (lp->lp_state & LACP_STATE_DISTRIBUTING) == 0) {
 669                 return;
 670         }
 671
 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"));
 675
 676         LACP_DPRINTF((lp, "disable distributing on aggregator %s, "
 677             "nports %d -> %d\n",
 678             lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
 679             la->la_nports, la->la_nports - 1));
 680
 681         TAILQ_REMOVE(&la->la_ports, lp, lp_dist_q);
 682         la->la_nports--;
 683         sc->sc_active = la->la_nports;
 684
 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);
 690         }
 691
 692         lp->lp_state &= ~LACP_STATE_DISTRIBUTING;
 693 }
 694
 695 static void
 696 lacp_enable_distributing(struct lacp_port *lp)
 697 {
 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];
 702
 703         LACP_LOCK_ASSERT(lsc);
 704
 705         if ((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0) {
 706                 return;
 707         }
 708
 709         LACP_DPRINTF((lp, "enable distributing on aggregator %s, "
 710             "nports %d -> %d\n",
 711             lacp_format_lagid_aggregator(la, buf, sizeof(buf)),
 712             la->la_nports, la->la_nports + 1));
 713
 714         KASSERT(la->la_refcnt > la->la_nports, ("aggregator refcnt invalid"));
 715         TAILQ_INSERT_HEAD(&la->la_ports, lp, lp_dist_q);
 716         la->la_nports++;
 717         sc->sc_active = la->la_nports;
 718
 719         lp->lp_state |= LACP_STATE_DISTRIBUTING;
 720
 721         if (lsc->lsc_active_aggregator == la) {
 722                 lacp_suppress_distributing(lsc, la);
 723                 lacp_update_portmap(lsc);
 724         } else
 725                 /* try to become the active aggregator */
 726                 lacp_select_active_aggregator(lsc);
 727 }
 728
 729 static void
 730 lacp_transit_expire(void *vp)
 731 {
 732         struct lacp_softc *lsc = vp;
 733
 734         LACP_LOCK_ASSERT(lsc);
 735
 736         LACP_TRACE(NULL);
 737
 738         lsc->lsc_suppress_distributing = FALSE;
 739 }
 740
 741 static void
 742 lacp_attach_sysctl(struct lacp_softc *lsc, struct sysctl_oid *p_oid)
 743 {
 744         struct lagg_softc *sc = lsc->lsc_softc;
 745
 746         SYSCTL_ADD_UINT(&sc->ctx, SYSCTL_CHILDREN(p_oid), OID_AUTO,
 747             "lacp_strict_mode",
 748             CTLFLAG_RW,
 749             &lsc->lsc_strict_mode,
 750             lsc->lsc_strict_mode,
 751             "Enable LACP strict mode");
 752 }
 753
 754 static void
 755 lacp_attach_sysctl_debug(struct lacp_softc *lsc, struct sysctl_oid *p_oid)
 756 {
 757         struct lagg_softc *sc = lsc->lsc_softc;
 758         struct sysctl_oid *oid;
 759
 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");
 763
 764         SYSCTL_ADD_UINT(&sc->ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
 765             "rx_test",
 766             CTLFLAG_RW,
 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,
 771             "tx_test",
 772             CTLFLAG_RW,
 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");
 776 }
 777
 778 int
 779 lacp_attach(struct lagg_softc *sc)
 780 {
 781         struct lacp_softc *lsc;
 782         struct sysctl_oid *oid;
 783
 784         lsc = malloc(sizeof(struct lacp_softc),
 785             M_DEVBUF, M_NOWAIT|M_ZERO);
 786         if (lsc == NULL)
 787                 return (ENOMEM);
 788
 789         sc->sc_psc = (caddr_t)lsc;
 790         lsc->lsc_softc = sc;
 791
 792         lsc->lsc_hashkey = arc4random();
 793         lsc->lsc_active_aggregator = NULL;
 794         lsc->lsc_strict_mode = 1;
 795         LACP_LOCK_INIT(lsc);
 796         TAILQ_INIT(&lsc->lsc_aggregators);
 797         LIST_INIT(&lsc->lsc_ports);
 798
 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");
 802
 803         /* Attach sysctl nodes */
 804         lacp_attach_sysctl(lsc, oid);
 805         lacp_attach_sysctl_debug(lsc, oid);
 806
 807         callout_init_mtx(&lsc->lsc_transit_callout, &lsc->lsc_mtx, 0);
 808         callout_init_mtx(&lsc->lsc_callout, &lsc->lsc_mtx, 0);
 809
 810         /* if the lagg is already up then do the same */
 811         if (sc->sc_ifp->if_drv_flags & IFF_DRV_RUNNING)
 812                 lacp_init(sc);
 813
 814         return (0);
 815 }
 816
 817 int
 818 lacp_detach(struct lagg_softc *sc)
 819 {
 820         struct lacp_softc *lsc = LACP_SOFTC(sc);
 821
 822         KASSERT(TAILQ_EMPTY(&lsc->lsc_aggregators),
 823             ("aggregators still active"));
 824         KASSERT(lsc->lsc_active_aggregator == NULL,
 825             ("aggregator still attached"));
 826
 827         sc->sc_psc = NULL;
 828         callout_drain(&lsc->lsc_transit_callout);
 829         callout_drain(&lsc->lsc_callout);
 830
 831         LACP_LOCK_DESTROY(lsc);
 832         free(lsc, M_DEVBUF);
 833         return (0);
 834 }
 835
 836 void
 837 lacp_init(struct lagg_softc *sc)
 838 {
 839         struct lacp_softc *lsc = LACP_SOFTC(sc);
 840
 841         LACP_LOCK(lsc);
 842         callout_reset(&lsc->lsc_callout, hz, lacp_tick, lsc);
 843         LACP_UNLOCK(lsc);
 844 }
 845
 846 void
 847 lacp_stop(struct lagg_softc *sc)
 848 {
 849         struct lacp_softc *lsc = LACP_SOFTC(sc);
 850
 851         LACP_LOCK(lsc);
 852         callout_stop(&lsc->lsc_transit_callout);
 853         callout_stop(&lsc->lsc_callout);
 854         LACP_UNLOCK(lsc);
 855 }
 856
 857 struct lagg_port *
 858 lacp_select_tx_port(struct lagg_softc *sc, struct mbuf *m)
 859 {
 860         struct lacp_softc *lsc = LACP_SOFTC(sc);
 861         struct lacp_portmap *pm;
 862         struct lacp_port *lp;
 863         uint32_t hash;
 864
 865         if (__predict_false(lsc->lsc_suppress_distributing)) {
 866                 LACP_DPRINTF((NULL, "%s: waiting transit\n", __func__));
 867                 return (NULL);
 868         }
 869
 870         pm = &lsc->lsc_pmap[lsc->lsc_activemap];
 871         if (pm->pm_count == 0) {
 872                 LACP_DPRINTF((NULL, "%s: no active aggregator\n", __func__));
 873                 return (NULL);
 874         }
 875
 876         if (sc->use_flowid && (m->m_flags & M_FLOWID))
 877                 hash = m->m_pkthdr.flowid;
 878         else
 879                 hash = lagg_hashmbuf(sc, m, lsc->lsc_hashkey);
 880         hash %= pm->pm_count;
 881         lp = pm->pm_map[hash];
 882
 883         KASSERT((lp->lp_state & LACP_STATE_DISTRIBUTING) != 0,
 884             ("aggregated port is not distributing"));
 885
 886         return (lp->lp_lagg);
 887 }
 888 /*
 889  * lacp_suppress_distributing: drop transmit packets for a while
 890  * to preserve packet ordering.
 891  */
 892
 893 static void
 894 lacp_suppress_distributing(struct lacp_softc *lsc, struct lacp_aggregator *la)
 895 {
 896         struct lacp_port *lp;
 897
 898         if (lsc->lsc_active_aggregator != la) {
 899                 return;
 900         }
 901
 902         LACP_TRACE(NULL);
 903
 904         lsc->lsc_suppress_distributing = TRUE;
 905
 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);
 910         }
 911
 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);
 915 }
 916
 917 static int
 918 lacp_compare_peerinfo(const struct lacp_peerinfo *a,
 919     const struct lacp_peerinfo *b)
 920 {
 921         return (memcmp(a, b, offsetof(struct lacp_peerinfo, lip_state)));
 922 }
 923
 924 static int
 925 lacp_compare_systemid(const struct lacp_systemid *a,
 926     const struct lacp_systemid *b)
 927 {
 928         return (memcmp(a, b, sizeof(*a)));
 929 }
 930
 931 #if 0   /* unused */
 932 static int
 933 lacp_compare_portid(const struct lacp_portid *a,
 934     const struct lacp_portid *b)
 935 {
 936         return (memcmp(a, b, sizeof(*a)));
 937 }
 938 #endif
 939
 940 static uint64_t
 941 lacp_aggregator_bandwidth(struct lacp_aggregator *la)
 942 {
 943         struct lacp_port *lp;
 944         uint64_t speed;
 945
 946         lp = TAILQ_FIRST(&la->la_ports);
 947         if (lp == NULL) {
 948                 return (0);
 949         }
 950
 951         speed = ifmedia_baudrate(lp->lp_media);
 952         speed *= la->la_nports;
 953         if (speed == 0) {
 954                 LACP_DPRINTF((lp, "speed 0? media=0x%x nports=%d\n",
 955                     lp->lp_media, la->la_nports));
 956         }
 957
 958         return (speed);
 959 }
 960
 961 /*
 962  * lacp_select_active_aggregator: select an aggregator to be used to transmit
 963  * packets from lagg(4) interface.
 964  */
 965
 966 static void
 967 lacp_select_active_aggregator(struct lacp_softc *lsc)
 968 {
 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];
 973
 974         LACP_TRACE(NULL);
 975
 976         TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
 977                 uint64_t speed;
 978
 979                 if (la->la_nports == 0) {
 980                         continue;
 981                 }
 982
 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));
 987
 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
 992                  */
 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)) {
 998                         best_la = la;
 999                         best_speed = speed;
1000                 }
1001         }
1002
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"));
1007
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))));
1013         } else {
1014                 LACP_DPRINTF((NULL, "active aggregator not changed\n"));
1015         }
1016         LACP_DPRINTF((NULL, "new %s\n",
1017             lacp_format_lagid_aggregator(best_la, buf, sizeof(buf))));
1018
1019         if (lsc->lsc_active_aggregator != best_la) {
1020                 lsc->lsc_active_aggregator = best_la;
1021                 lacp_update_portmap(lsc);
1022                 if (best_la) {
1023                         lacp_suppress_distributing(lsc, best_la);
1024                 }
1025         }
1026 }
1027
1028 /*
1029  * Updated the inactive portmap array with the new list of ports and
1030  * make it live.
1031  */
1032 static void
1033 lacp_update_portmap(struct lacp_softc *lsc)
1034 {
1035         struct lagg_softc *sc = lsc->lsc_softc;
1036         struct lacp_aggregator *la;
1037         struct lacp_portmap *p;
1038         struct lacp_port *lp;
1039         uint64_t speed;
1040         u_int newmap;
1041         int i;
1042
1043         newmap = lsc->lsc_activemap == 0 ? 1 : 0;
1044         p = &lsc->lsc_pmap[newmap];
1045         la = lsc->lsc_active_aggregator;
1046         speed = 0;
1047         bzero(p, sizeof(struct lacp_portmap));
1048
1049         if (la != NULL && la->la_nports > 0) {
1050                 p->pm_count = la->la_nports;
1051                 i = 0;
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);
1056         }
1057         sc->sc_ifp->if_baudrate = speed;
1058
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",
1062                     lsc->lsc_activemap,
1063                     lsc->lsc_pmap[lsc->lsc_activemap].pm_count));
1064 }
1065
1066 static uint16_t
1067 lacp_compose_key(struct lacp_port *lp)
1068 {
1069         struct lagg_port *lgp = lp->lp_lagg;
1070         struct lagg_softc *sc = lgp->lp_softc;
1071         u_int media = lp->lp_media;
1072         uint16_t key;
1073
1074         if ((lp->lp_state & LACP_STATE_AGGREGATION) == 0) {
1075
1076                 /*
1077                  * non-aggregatable links should have unique keys.
1078                  *
1079                  * XXX this isn't really unique as if_index is 16 bit.
1080                  */
1081
1082                 /* bit 0..14:   (some bits of) if_index of this port */
1083                 key = lp->lp_ifp->if_index;
1084                 /* bit 15:      1 */
1085                 key |= 0x8000;
1086         } else {
1087                 u_int subtype = IFM_SUBTYPE(media);
1088
1089                 KASSERT(IFM_TYPE(media) == IFM_ETHER, ("invalid media type"));
1090                 KASSERT((media & IFM_FDX) != 0, ("aggregating HDX interface"));
1091
1092                 /* bit 0..4:    IFM_SUBTYPE */
1093                 key = subtype;
1094                 /* bit 5..14:   (some bits of) if_index of lagg device */
1095                 key |= 0x7fe0 & ((sc->sc_ifp->if_index) << 5);
1096                 /* bit 15:      0 */
1097         }
1098         return (htons(key));
1099 }
1100
1101 static void
1102 lacp_aggregator_addref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1103 {
1104         char buf[LACP_LAGIDSTR_MAX+1];
1105
1106         LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1107             __func__,
1108             lacp_format_lagid(&la->la_actor, &la->la_partner,
1109             buf, sizeof(buf)),
1110             la->la_refcnt, la->la_refcnt + 1));
1111
1112         KASSERT(la->la_refcnt > 0, ("refcount <= 0"));
1113         la->la_refcnt++;
1114         KASSERT(la->la_refcnt > la->la_nports, ("invalid refcount"));
1115 }
1116
1117 static void
1118 lacp_aggregator_delref(struct lacp_softc *lsc, struct lacp_aggregator *la)
1119 {
1120         char buf[LACP_LAGIDSTR_MAX+1];
1121
1122         LACP_DPRINTF((NULL, "%s: lagid=%s, refcnt %d -> %d\n",
1123             __func__,
1124             lacp_format_lagid(&la->la_actor, &la->la_partner,
1125             buf, sizeof(buf)),
1126             la->la_refcnt, la->la_refcnt - 1));
1127
1128         KASSERT(la->la_refcnt > la->la_nports, ("invalid refcnt"));
1129         la->la_refcnt--;
1130         if (la->la_refcnt > 0) {
1131                 return;
1132         }
1133
1134         KASSERT(la->la_refcnt == 0, ("refcount not zero"));
1135         KASSERT(lsc->lsc_active_aggregator != la, ("aggregator active"));
1136
1137         TAILQ_REMOVE(&lsc->lsc_aggregators, la, la_q);
1138
1139         free(la, M_DEVBUF);
1140 }
1141
1142 /*
1143  * lacp_aggregator_get: allocate an aggregator.
1144  */
1145
1146 static struct lacp_aggregator *
1147 lacp_aggregator_get(struct lacp_softc *lsc, struct lacp_port *lp)
1148 {
1149         struct lacp_aggregator *la;
1150
1151         la = malloc(sizeof(*la), M_DEVBUF, M_NOWAIT);
1152         if (la) {
1153                 la->la_refcnt = 1;
1154                 la->la_nports = 0;
1155                 TAILQ_INIT(&la->la_ports);
1156                 la->la_pending = 0;
1157                 TAILQ_INSERT_TAIL(&lsc->lsc_aggregators, la, la_q);
1158         }
1159
1160         return (la);
1161 }
1162
1163 /*
1164  * lacp_fill_aggregator_id: setup a newly allocated aggregator from a port.
1165  */
1166
1167 static void
1168 lacp_fill_aggregator_id(struct lacp_aggregator *la, const struct lacp_port *lp)
1169 {
1170         lacp_fill_aggregator_id_peer(&la->la_partner, &lp->lp_partner);
1171         lacp_fill_aggregator_id_peer(&la->la_actor, &lp->lp_actor);
1172
1173         la->la_actor.lip_state = lp->lp_state & LACP_STATE_AGGREGATION;
1174 }
1175
1176 static void
1177 lacp_fill_aggregator_id_peer(struct lacp_peerinfo *lpi_aggr,
1178     const struct lacp_peerinfo *lpi_port)
1179 {
1180         memset(lpi_aggr, 0, sizeof(*lpi_aggr));
1181         lpi_aggr->lip_systemid = lpi_port->lip_systemid;
1182         lpi_aggr->lip_key = lpi_port->lip_key;
1183 }
1184
1185 /*
1186  * lacp_aggregator_is_compatible: check if a port can join to an aggregator.
1187  */
1188
1189 static int
1190 lacp_aggregator_is_compatible(const struct lacp_aggregator *la,
1191     const struct lacp_port *lp)
1192 {
1193         if (!(lp->lp_state & LACP_STATE_AGGREGATION) ||
1194             !(lp->lp_partner.lip_state & LACP_STATE_AGGREGATION)) {
1195                 return (0);
1196         }
1197
1198         if (!(la->la_actor.lip_state & LACP_STATE_AGGREGATION)) {
1199                 return (0);
1200         }
1201
1202         if (!lacp_peerinfo_is_compatible(&la->la_partner, &lp->lp_partner)) {
1203                 return (0);
1204         }
1205
1206         if (!lacp_peerinfo_is_compatible(&la->la_actor, &lp->lp_actor)) {
1207                 return (0);
1208         }
1209
1210         return (1);
1211 }
1212
1213 static int
1214 lacp_peerinfo_is_compatible(const struct lacp_peerinfo *a,
1215     const struct lacp_peerinfo *b)
1216 {
1217         if (memcmp(&a->lip_systemid, &b->lip_systemid,
1218             sizeof(a->lip_systemid))) {
1219                 return (0);
1220         }
1221
1222         if (memcmp(&a->lip_key, &b->lip_key, sizeof(a->lip_key))) {
1223                 return (0);
1224         }
1225
1226         return (1);
1227 }
1228
1229 static void
1230 lacp_port_enable(struct lacp_port *lp)
1231 {
1232         lp->lp_state |= LACP_STATE_AGGREGATION;
1233 }
1234
1235 static void
1236 lacp_port_disable(struct lacp_port *lp)
1237 {
1238         lacp_set_mux(lp, LACP_MUX_DETACHED);
1239
1240         lp->lp_state &= ~LACP_STATE_AGGREGATION;
1241         lp->lp_selected = LACP_UNSELECTED;
1242         lacp_sm_rx_record_default(lp);
1243         lp->lp_partner.lip_state &= ~LACP_STATE_AGGREGATION;
1244         lp->lp_state &= ~LACP_STATE_EXPIRED;
1245 }
1246
1247 /*
1248  * lacp_select: select an aggregator.  create one if necessary.
1249  */
1250 static void
1251 lacp_select(struct lacp_port *lp)
1252 {
1253         struct lacp_softc *lsc = lp->lp_lsc;
1254         struct lacp_aggregator *la;
1255         char buf[LACP_LAGIDSTR_MAX+1];
1256
1257         if (lp->lp_aggregator) {
1258                 return;
1259         }
1260
1261         KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1262             ("timer_wait_while still active"));
1263
1264         LACP_DPRINTF((lp, "port lagid=%s\n",
1265             lacp_format_lagid(&lp->lp_actor, &lp->lp_partner,
1266             buf, sizeof(buf))));
1267
1268         TAILQ_FOREACH(la, &lsc->lsc_aggregators, la_q) {
1269                 if (lacp_aggregator_is_compatible(la, lp)) {
1270                         break;
1271                 }
1272         }
1273
1274         if (la == NULL) {
1275                 la = lacp_aggregator_get(lsc, lp);
1276                 if (la == NULL) {
1277                         LACP_DPRINTF((lp, "aggregator creation failed\n"));
1278
1279                         /*
1280                          * will retry on the next tick.
1281                          */
1282
1283                         return;
1284                 }
1285                 lacp_fill_aggregator_id(la, lp);
1286                 LACP_DPRINTF((lp, "aggregator created\n"));
1287         } else {
1288                 LACP_DPRINTF((lp, "compatible aggregator found\n"));
1289                 if (la->la_refcnt == LACP_MAX_PORTS)
1290                         return;
1291                 lacp_aggregator_addref(lsc, la);
1292         }
1293
1294         LACP_DPRINTF((lp, "aggregator lagid=%s\n",
1295             lacp_format_lagid(&la->la_actor, &la->la_partner,
1296             buf, sizeof(buf))));
1297
1298         lp->lp_aggregator = la;
1299         lp->lp_selected = LACP_SELECTED;
1300 }
1301
1302 /*
1303  * lacp_unselect: finish unselect/detach process.
1304  */
1305
1306 static void
1307 lacp_unselect(struct lacp_port *lp)
1308 {
1309         struct lacp_softc *lsc = lp->lp_lsc;
1310         struct lacp_aggregator *la = lp->lp_aggregator;
1311
1312         KASSERT(!LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1313             ("timer_wait_while still active"));
1314
1315         if (la == NULL) {
1316                 return;
1317         }
1318
1319         lp->lp_aggregator = NULL;
1320         lacp_aggregator_delref(lsc, la);
1321 }
1322
1323 /* mux machine */
1324
1325 static void
1326 lacp_sm_mux(struct lacp_port *lp)
1327 {
1328         struct lagg_port *lgp = lp->lp_lagg;
1329         struct lagg_softc *sc = lgp->lp_softc;
1330         enum lacp_mux_state new_state;
1331         boolean_t p_sync =
1332                     (lp->lp_partner.lip_state & LACP_STATE_SYNC) != 0;
1333         boolean_t p_collecting =
1334             (lp->lp_partner.lip_state & LACP_STATE_COLLECTING) != 0;
1335         enum lacp_selected selected = lp->lp_selected;
1336         struct lacp_aggregator *la;
1337
1338         if (lacp_debug > 1)
1339                 lacp_dprintf(lp, "%s: state= 0x%x, selected= 0x%x, "
1340                     "p_sync= 0x%x, p_collecting= 0x%x\n", __func__,
1341                     lp->lp_mux_state, selected, p_sync, p_collecting);
1342
1343 re_eval:
1344         la = lp->lp_aggregator;
1345         KASSERT(lp->lp_mux_state == LACP_MUX_DETACHED || la != NULL,
1346             ("MUX not detached"));
1347         new_state = lp->lp_mux_state;
1348         switch (lp->lp_mux_state) {
1349         case LACP_MUX_DETACHED:
1350                 if (selected != LACP_UNSELECTED) {
1351                         new_state = LACP_MUX_WAITING;
1352                 }
1353                 break;
1354         case LACP_MUX_WAITING:
1355                 KASSERT(la->la_pending > 0 ||
1356                     !LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE),
1357                     ("timer_wait_while still active"));
1358                 if (selected == LACP_SELECTED && la->la_pending == 0) {
1359                         new_state = LACP_MUX_ATTACHED;
1360                 } else if (selected == LACP_UNSELECTED) {
1361                         new_state = LACP_MUX_DETACHED;
1362                 }
1363                 break;
1364         case LACP_MUX_ATTACHED:
1365                 if (selected == LACP_SELECTED && p_sync) {
1366                         new_state = LACP_MUX_COLLECTING;
1367                 } else if (selected != LACP_SELECTED) {
1368                         new_state = LACP_MUX_DETACHED;
1369                 }
1370                 break;
1371         case LACP_MUX_COLLECTING:
1372                 if (selected == LACP_SELECTED && p_sync && p_collecting) {
1373                         new_state = LACP_MUX_DISTRIBUTING;
1374                 } else if (selected != LACP_SELECTED || !p_sync) {
1375                         new_state = LACP_MUX_ATTACHED;
1376                 }
1377                 break;
1378         case LACP_MUX_DISTRIBUTING:
1379                 if (selected != LACP_SELECTED || !p_sync || !p_collecting) {
1380                         new_state = LACP_MUX_COLLECTING;
1381                         lacp_dprintf(lp, "Interface stopped DISTRIBUTING, possible flapping\n");
1382                         sc->sc_flapping++;
1383                 }
1384                 break;
1385         default:
1386                 panic("%s: unknown state", __func__);
1387         }
1388
1389         if (lp->lp_mux_state == new_state) {
1390                 return;
1391         }
1392
1393         lacp_set_mux(lp, new_state);
1394         goto re_eval;
1395 }
1396
1397 static void
1398 lacp_set_mux(struct lacp_port *lp, enum lacp_mux_state new_state)
1399 {
1400         struct lacp_aggregator *la = lp->lp_aggregator;
1401
1402         if (lp->lp_mux_state == new_state) {
1403                 return;
1404         }
1405
1406         switch (new_state) {
1407         case LACP_MUX_DETACHED:
1408                 lp->lp_state &= ~LACP_STATE_SYNC;
1409                 lacp_disable_distributing(lp);
1410                 lacp_disable_collecting(lp);
1411                 lacp_sm_assert_ntt(lp);
1412                 /* cancel timer */
1413                 if (LACP_TIMER_ISARMED(lp, LACP_TIMER_WAIT_WHILE)) {
1414                         KASSERT(la->la_pending > 0,
1415                             ("timer_wait_while not active"));
1416                         la->la_pending--;
1417                 }
1418                 LACP_TIMER_DISARM(lp, LACP_TIMER_WAIT_WHILE);
1419                 lacp_unselect(lp);
1420                 break;
1421         case LACP_MUX_WAITING:
1422                 LACP_TIMER_ARM(lp, LACP_TIMER_WAIT_WHILE,
1423                     LACP_AGGREGATE_WAIT_TIME);
1424                 la->la_pending++;
1425                 break;
1426         case LACP_MUX_ATTACHED:
1427                 lp->lp_state |= LACP_STATE_SYNC;
1428                 lacp_disable_collecting(lp);
1429                 lacp_sm_assert_ntt(lp);
1430                 break;
1431         case LACP_MUX_COLLECTING:
1432                 lacp_enable_collecting(lp);
1433                 lacp_disable_distributing(lp);
1434                 lacp_sm_assert_ntt(lp);
1435                 break;
1436         case LACP_MUX_DISTRIBUTING:
1437                 lacp_enable_distributing(lp);
1438                 break;
1439         default:
1440                 panic("%s: unknown state", __func__);
1441         }
1442
1443         LACP_DPRINTF((lp, "mux_state %d -> %d\n", lp->lp_mux_state, new_state));
1444
1445         lp->lp_mux_state = new_state;
1446 }
1447
1448 static void
1449 lacp_sm_mux_timer(struct lacp_port *lp)
1450 {
1451         struct lacp_aggregator *la = lp->lp_aggregator;
1452         char buf[LACP_LAGIDSTR_MAX+1];
1453
1454         KASSERT(la->la_pending > 0, ("no pending event"));
1455
1456         LACP_DPRINTF((lp, "%s: aggregator %s, pending %d -> %d\n", __func__,
1457             lacp_format_lagid(&la->la_actor, &la->la_partner,
1458             buf, sizeof(buf)),
1459             la->la_pending, la->la_pending - 1));
1460
1461         la->la_pending--;
1462 }
1463
1464 /* periodic transmit machine */
1465
1466 static void
1467 lacp_sm_ptx_update_timeout(struct lacp_port *lp, uint8_t oldpstate)
1468 {
1469         if (LACP_STATE_EQ(oldpstate, lp->lp_partner.lip_state,
1470             LACP_STATE_TIMEOUT)) {
1471                 return;
1472         }
1473
1474         LACP_DPRINTF((lp, "partner timeout changed\n"));
1475
1476         /*
1477          * FAST_PERIODIC -> SLOW_PERIODIC
1478          * or
1479          * SLOW_PERIODIC (-> PERIODIC_TX) -> FAST_PERIODIC
1480          *
1481          * let lacp_sm_ptx_tx_schedule to update timeout.
1482          */
1483
1484         LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1485
1486         /*
1487          * if timeout has been shortened, assert NTT.
1488          */
1489
1490         if ((lp->lp_partner.lip_state & LACP_STATE_TIMEOUT)) {
1491                 lacp_sm_assert_ntt(lp);
1492         }
1493 }
1494
1495 static void
1496 lacp_sm_ptx_tx_schedule(struct lacp_port *lp)
1497 {
1498         int timeout;
1499
1500         if (!(lp->lp_state & LACP_STATE_ACTIVITY) &&
1501             !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY)) {
1502
1503                 /*
1504                  * NO_PERIODIC
1505                  */
1506
1507                 LACP_TIMER_DISARM(lp, LACP_TIMER_PERIODIC);
1508                 return;
1509         }
1510
1511         if (LACP_TIMER_ISARMED(lp, LACP_TIMER_PERIODIC)) {
1512                 return;
1513         }
1514
1515         timeout = (lp->lp_partner.lip_state & LACP_STATE_TIMEOUT) ?
1516             LACP_FAST_PERIODIC_TIME : LACP_SLOW_PERIODIC_TIME;
1517
1518         LACP_TIMER_ARM(lp, LACP_TIMER_PERIODIC, timeout);
1519 }
1520
1521 static void
1522 lacp_sm_ptx_timer(struct lacp_port *lp)
1523 {
1524         lacp_sm_assert_ntt(lp);
1525 }
1526
1527 static void
1528 lacp_sm_rx(struct lacp_port *lp, const struct lacpdu *du)
1529 {
1530         int timeout;
1531
1532         /*
1533          * check LACP_DISABLED first
1534          */
1535
1536         if (!(lp->lp_state & LACP_STATE_AGGREGATION)) {
1537                 return;
1538         }
1539
1540         /*
1541          * check loopback condition.
1542          */
1543
1544         if (!lacp_compare_systemid(&du->ldu_actor.lip_systemid,
1545             &lp->lp_actor.lip_systemid)) {
1546                 return;
1547         }
1548
1549         /*
1550          * EXPIRED, DEFAULTED, CURRENT -> CURRENT
1551          */
1552
1553         lacp_sm_rx_update_selected(lp, du);
1554         lacp_sm_rx_update_ntt(lp, du);
1555         lacp_sm_rx_record_pdu(lp, du);
1556
1557         timeout = (lp->lp_state & LACP_STATE_TIMEOUT) ?
1558             LACP_SHORT_TIMEOUT_TIME : LACP_LONG_TIMEOUT_TIME;
1559         LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, timeout);
1560
1561         lp->lp_state &= ~LACP_STATE_EXPIRED;
1562
1563         /*
1564          * kick transmit machine without waiting the next tick.
1565          */
1566
1567         lacp_sm_tx(lp);
1568 }
1569
1570 static void
1571 lacp_sm_rx_set_expired(struct lacp_port *lp)
1572 {
1573         lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1574         lp->lp_partner.lip_state |= LACP_STATE_TIMEOUT;
1575         LACP_TIMER_ARM(lp, LACP_TIMER_CURRENT_WHILE, LACP_SHORT_TIMEOUT_TIME);
1576         lp->lp_state |= LACP_STATE_EXPIRED;
1577 }
1578
1579 static void
1580 lacp_sm_rx_timer(struct lacp_port *lp)
1581 {
1582         if ((lp->lp_state & LACP_STATE_EXPIRED) == 0) {
1583                 /* CURRENT -> EXPIRED */
1584                 LACP_DPRINTF((lp, "%s: CURRENT -> EXPIRED\n", __func__));
1585                 lacp_sm_rx_set_expired(lp);
1586         } else {
1587                 /* EXPIRED -> DEFAULTED */
1588                 LACP_DPRINTF((lp, "%s: EXPIRED -> DEFAULTED\n", __func__));
1589                 lacp_sm_rx_update_default_selected(lp);
1590                 lacp_sm_rx_record_default(lp);
1591                 lp->lp_state &= ~LACP_STATE_EXPIRED;
1592         }
1593 }
1594
1595 static void
1596 lacp_sm_rx_record_pdu(struct lacp_port *lp, const struct lacpdu *du)
1597 {
1598         boolean_t active;
1599         uint8_t oldpstate;
1600         char buf[LACP_STATESTR_MAX+1];
1601
1602         LACP_TRACE(lp);
1603
1604         oldpstate = lp->lp_partner.lip_state;
1605
1606         active = (du->ldu_actor.lip_state & LACP_STATE_ACTIVITY)
1607             || ((lp->lp_state & LACP_STATE_ACTIVITY) &&
1608             (du->ldu_partner.lip_state & LACP_STATE_ACTIVITY));
1609
1610         lp->lp_partner = du->ldu_actor;
1611         if (active &&
1612             ((LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1613             LACP_STATE_AGGREGATION) &&
1614             !lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner))
1615             || (du->ldu_partner.lip_state & LACP_STATE_AGGREGATION) == 0)) {
1616                 /* XXX nothing? */
1617         } else {
1618                 lp->lp_partner.lip_state &= ~LACP_STATE_SYNC;
1619         }
1620
1621         lp->lp_state &= ~LACP_STATE_DEFAULTED;
1622
1623         if (oldpstate != lp->lp_partner.lip_state) {
1624                 LACP_DPRINTF((lp, "old pstate %s\n",
1625                     lacp_format_state(oldpstate, buf, sizeof(buf))));
1626                 LACP_DPRINTF((lp, "new pstate %s\n",
1627                     lacp_format_state(lp->lp_partner.lip_state, buf,
1628                     sizeof(buf))));
1629         }
1630
1631         /* XXX Hack, still need to implement 5.4.9 para 2,3,4 */
1632         if (lp->lp_lsc->lsc_strict_mode)
1633                 lp->lp_partner.lip_state |= LACP_STATE_SYNC;
1634
1635         lacp_sm_ptx_update_timeout(lp, oldpstate);
1636 }
1637
1638 static void
1639 lacp_sm_rx_update_ntt(struct lacp_port *lp, const struct lacpdu *du)
1640 {
1641
1642         LACP_TRACE(lp);
1643
1644         if (lacp_compare_peerinfo(&lp->lp_actor, &du->ldu_partner) ||
1645             !LACP_STATE_EQ(lp->lp_state, du->ldu_partner.lip_state,
1646             LACP_STATE_ACTIVITY | LACP_STATE_SYNC | LACP_STATE_AGGREGATION)) {
1647                 LACP_DPRINTF((lp, "%s: assert ntt\n", __func__));
1648                 lacp_sm_assert_ntt(lp);
1649         }
1650 }
1651
1652 static void
1653 lacp_sm_rx_record_default(struct lacp_port *lp)
1654 {
1655         uint8_t oldpstate;
1656
1657         LACP_TRACE(lp);
1658
1659         oldpstate = lp->lp_partner.lip_state;
1660         if (lp->lp_lsc->lsc_strict_mode)
1661                 lp->lp_partner = lacp_partner_admin_strict;
1662         else
1663                 lp->lp_partner = lacp_partner_admin_optimistic;;
1664         lp->lp_state |= LACP_STATE_DEFAULTED;
1665         lacp_sm_ptx_update_timeout(lp, oldpstate);
1666 }
1667
1668 static void
1669 lacp_sm_rx_update_selected_from_peerinfo(struct lacp_port *lp,
1670     const struct lacp_peerinfo *info)
1671 {
1672
1673         LACP_TRACE(lp);
1674
1675         if (lacp_compare_peerinfo(&lp->lp_partner, info) ||
1676             !LACP_STATE_EQ(lp->lp_partner.lip_state, info->lip_state,
1677             LACP_STATE_AGGREGATION)) {
1678                 lp->lp_selected = LACP_UNSELECTED;
1679                 /* mux machine will clean up lp->lp_aggregator */
1680         }
1681 }
1682
1683 static void
1684 lacp_sm_rx_update_selected(struct lacp_port *lp, const struct lacpdu *du)
1685 {
1686
1687         LACP_TRACE(lp);
1688
1689         lacp_sm_rx_update_selected_from_peerinfo(lp, &du->ldu_actor);
1690 }
1691
1692 static void
1693 lacp_sm_rx_update_default_selected(struct lacp_port *lp)
1694 {
1695
1696         LACP_TRACE(lp);
1697
1698         if (lp->lp_lsc->lsc_strict_mode)
1699                 lacp_sm_rx_update_selected_from_peerinfo(lp,
1700                     &lacp_partner_admin_strict);
1701         else
1702                 lacp_sm_rx_update_selected_from_peerinfo(lp,
1703                     &lacp_partner_admin_optimistic);
1704 }
1705
1706 /* transmit machine */
1707
1708 static void
1709 lacp_sm_tx(struct lacp_port *lp)
1710 {
1711         int error = 0;
1712
1713         if (!(lp->lp_state & LACP_STATE_AGGREGATION)
1714 #if 1
1715             || (!(lp->lp_state & LACP_STATE_ACTIVITY)
1716             && !(lp->lp_partner.lip_state & LACP_STATE_ACTIVITY))
1717 #endif
1718             ) {
1719                 lp->lp_flags &= ~LACP_PORT_NTT;
1720         }
1721
1722         if (!(lp->lp_flags & LACP_PORT_NTT)) {
1723                 return;
1724         }
1725
1726         /* Rate limit to 3 PDUs per LACP_FAST_PERIODIC_TIME */
1727         if (ppsratecheck(&lp->lp_last_lacpdu, &lp->lp_lacpdu_sent,
1728                     (3 / LACP_FAST_PERIODIC_TIME)) == 0) {
1729                 LACP_DPRINTF((lp, "rate limited pdu\n"));
1730                 return;
1731         }
1732
1733         if (((1 << lp->lp_ifp->if_dunit) & lp->lp_lsc->lsc_debug.lsc_tx_test) == 0) {
1734                 error = lacp_xmit_lacpdu(lp);
1735         } else {
1736                 LACP_TPRINTF((lp, "Dropping TX PDU\n"));
1737         }
1738
1739         if (error == 0) {
1740                 lp->lp_flags &= ~LACP_PORT_NTT;
1741         } else {
1742                 LACP_DPRINTF((lp, "lacpdu transmit failure, error %d\n",
1743                     error));
1744         }
1745 }
1746
1747 static void
1748 lacp_sm_assert_ntt(struct lacp_port *lp)
1749 {
1750
1751         lp->lp_flags |= LACP_PORT_NTT;
1752 }
1753
1754 static void
1755 lacp_run_timers(struct lacp_port *lp)
1756 {
1757         int i;
1758
1759         for (i = 0; i < LACP_NTIMER; i++) {
1760                 KASSERT(lp->lp_timer[i] >= 0,
1761                     ("invalid timer value %d", lp->lp_timer[i]));
1762                 if (lp->lp_timer[i] == 0) {
1763                         continue;
1764                 } else if (--lp->lp_timer[i] <= 0) {
1765                         if (lacp_timer_funcs[i]) {
1766                                 (*lacp_timer_funcs[i])(lp);
1767                         }
1768                 }
1769         }
1770 }
1771
1772 int
1773 lacp_marker_input(struct lacp_port *lp, struct mbuf *m)
1774 {
1775         struct lacp_softc *lsc = lp->lp_lsc;
1776         struct lagg_port *lgp = lp->lp_lagg;
1777         struct lacp_port *lp2;
1778         struct markerdu *mdu;
1779         int error = 0;
1780         int pending = 0;
1781
1782         if (m->m_pkthdr.len != sizeof(*mdu)) {
1783                 goto bad;
1784         }
1785
1786         if ((m->m_flags & M_MCAST) == 0) {
1787                 goto bad;
1788         }
1789
1790         if (m->m_len < sizeof(*mdu)) {
1791                 m = m_pullup(m, sizeof(*mdu));
1792                 if (m == NULL) {
1793                         return (ENOMEM);
1794                 }
1795         }
1796
1797         mdu = mtod(m, struct markerdu *);
1798
1799         if (memcmp(&mdu->mdu_eh.ether_dhost,
1800             &ethermulticastaddr_slowprotocols, ETHER_ADDR_LEN)) {
1801                 goto bad;
1802         }
1803
1804         if (mdu->mdu_sph.sph_version != 1) {
1805                 goto bad;
1806         }
1807
1808         switch (mdu->mdu_tlv.tlv_type) {
1809         case MARKER_TYPE_INFO:
1810                 if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1811                     marker_info_tlv_template, TRUE)) {
1812                         goto bad;
1813                 }
1814                 mdu->mdu_tlv.tlv_type = MARKER_TYPE_RESPONSE;
1815                 memcpy(&mdu->mdu_eh.ether_dhost,
1816                     &ethermulticastaddr_slowprotocols, ETHER_ADDR_LEN);
1817                 memcpy(&mdu->mdu_eh.ether_shost,
1818                     lgp->lp_lladdr, ETHER_ADDR_LEN);
1819                 error = lagg_enqueue(lp->lp_ifp, m);
1820                 break;
1821
1822         case MARKER_TYPE_RESPONSE:
1823                 if (tlv_check(mdu, sizeof(*mdu), &mdu->mdu_tlv,
1824                     marker_response_tlv_template, TRUE)) {
1825                         goto bad;
1826                 }
1827                 LACP_DPRINTF((lp, "marker response, port=%u, sys=%6D, id=%u\n",
1828                     ntohs(mdu->mdu_info.mi_rq_port), mdu->mdu_info.mi_rq_system,
1829                     ":", ntohl(mdu->mdu_info.mi_rq_xid)));
1830
1831                 /* Verify that it is the last marker we sent out */
1832                 if (memcmp(&mdu->mdu_info, &lp->lp_marker,
1833                     sizeof(struct lacp_markerinfo)))
1834                         goto bad;
1835
1836                 LACP_LOCK(lsc);
1837                 lp->lp_flags &= ~LACP_PORT_MARK;
1838
1839                 if (lsc->lsc_suppress_distributing) {
1840                         /* Check if any ports are waiting for a response */
1841                         LIST_FOREACH(lp2, &lsc->lsc_ports, lp_next) {
1842                                 if (lp2->lp_flags & LACP_PORT_MARK) {
1843                                         pending = 1;
1844                                         break;
1845                                 }
1846                         }
1847
1848                         if (pending == 0) {
1849                                 /* All interface queues are clear */
1850                                 LACP_DPRINTF((NULL, "queue flush complete\n"));
1851                                 lsc->lsc_suppress_distributing = FALSE;
1852                         }
1853                 }
1854                 LACP_UNLOCK(lsc);
1855                 m_freem(m);
1856                 break;
1857
1858         default:
1859                 goto bad;
1860         }
1861
1862         return (error);
1863
1864 bad:
1865         LACP_DPRINTF((lp, "bad marker frame\n"));
1866         m_freem(m);
1867         return (EINVAL);
1868 }
1869
1870 static int
1871 tlv_check(const void *p, size_t size, const struct tlvhdr *tlv,
1872     const struct tlv_template *tmpl, boolean_t check_type)
1873 {
1874         while (/* CONSTCOND */ 1) {
1875                 if ((const char *)tlv - (const char *)p + sizeof(*tlv) > size) {
1876                         return (EINVAL);
1877                 }
1878                 if ((check_type && tlv->tlv_type != tmpl->tmpl_type) ||
1879                     tlv->tlv_length != tmpl->tmpl_length) {
1880                         return (EINVAL);
1881                 }
1882                 if (tmpl->tmpl_type == 0) {
1883                         break;
1884                 }
1885                 tlv = (const struct tlvhdr *)
1886                     ((const char *)tlv + tlv->tlv_length);
1887                 tmpl++;
1888         }
1889
1890         return (0);
1891 }
1892
1893 /* Debugging */
1894 const char *
1895 lacp_format_mac(const uint8_t *mac, char *buf, size_t buflen)
1896 {
1897         snprintf(buf, buflen, "%02X-%02X-%02X-%02X-%02X-%02X",
1898             (int)mac[0],
1899             (int)mac[1],
1900             (int)mac[2],
1901             (int)mac[3],
1902             (int)mac[4],
1903             (int)mac[5]);
1904
1905         return (buf);
1906 }
1907
1908 const char *
1909 lacp_format_systemid(const struct lacp_systemid *sysid,
1910     char *buf, size_t buflen)
1911 {
1912         char macbuf[LACP_MACSTR_MAX+1];
1913
1914         snprintf(buf, buflen, "%04X,%s",
1915             ntohs(sysid->lsi_prio),
1916             lacp_format_mac(sysid->lsi_mac, macbuf, sizeof(macbuf)));
1917
1918         return (buf);
1919 }
1920
1921 const char *
1922 lacp_format_portid(const struct lacp_portid *portid, char *buf, size_t buflen)
1923 {
1924         snprintf(buf, buflen, "%04X,%04X",
1925             ntohs(portid->lpi_prio),
1926             ntohs(portid->lpi_portno));
1927
1928         return (buf);
1929 }
1930
1931 const char *
1932 lacp_format_partner(const struct lacp_peerinfo *peer, char *buf, size_t buflen)
1933 {
1934         char sysid[LACP_SYSTEMIDSTR_MAX+1];
1935         char portid[LACP_PORTIDSTR_MAX+1];
1936
1937         snprintf(buf, buflen, "(%s,%04X,%s)",
1938             lacp_format_systemid(&peer->lip_systemid, sysid, sizeof(sysid)),
1939             ntohs(peer->lip_key),
1940             lacp_format_portid(&peer->lip_portid, portid, sizeof(portid)));
1941
1942         return (buf);
1943 }
1944
1945 const char *
1946 lacp_format_lagid(const struct lacp_peerinfo *a,
1947     const struct lacp_peerinfo *b, char *buf, size_t buflen)
1948 {
1949         char astr[LACP_PARTNERSTR_MAX+1];
1950         char bstr[LACP_PARTNERSTR_MAX+1];
1951
1952 #if 0
1953         /*
1954          * there's a convention to display small numbered peer
1955          * in the left.
1956          */
1957
1958         if (lacp_compare_peerinfo(a, b) > 0) {
1959                 const struct lacp_peerinfo *t;
1960
1961                 t = a;
1962                 a = b;
1963                 b = t;
1964         }
1965 #endif
1966
1967         snprintf(buf, buflen, "[%s,%s]",
1968             lacp_format_partner(a, astr, sizeof(astr)),
1969             lacp_format_partner(b, bstr, sizeof(bstr)));
1970
1971         return (buf);
1972 }
1973
1974 const char *
1975 lacp_format_lagid_aggregator(const struct lacp_aggregator *la,
1976     char *buf, size_t buflen)
1977 {
1978         if (la == NULL) {
1979                 return ("(none)");
1980         }
1981
1982         return (lacp_format_lagid(&la->la_actor, &la->la_partner, buf, buflen));
1983 }
1984
1985 const char *
1986 lacp_format_state(uint8_t state, char *buf, size_t buflen)
1987 {
1988         snprintf(buf, buflen, "%b", state, LACP_STATE_BITS);
1989         return (buf);
1990 }
1991
1992 static void
1993 lacp_dump_lacpdu(const struct lacpdu *du)
1994 {
1995         char buf[LACP_PARTNERSTR_MAX+1];
1996         char buf2[LACP_STATESTR_MAX+1];
1997
1998         printf("actor=%s\n",
1999             lacp_format_partner(&du->ldu_actor, buf, sizeof(buf)));
2000         printf("actor.state=%s\n",
2001             lacp_format_state(du->ldu_actor.lip_state, buf2, sizeof(buf2)));
2002         printf("partner=%s\n",
2003             lacp_format_partner(&du->ldu_partner, buf, sizeof(buf)));
2004         printf("partner.state=%s\n",
2005             lacp_format_state(du->ldu_partner.lip_state, buf2, sizeof(buf2)));
2006
2007         printf("maxdelay=%d\n", ntohs(du->ldu_collector.lci_maxdelay));
2008 }
2009
2010 static void
2011 lacp_dprintf(const struct lacp_port *lp, const char *fmt, ...)
2012 {
2013         va_list va;
2014
2015         if (lp) {
2016                 printf("%s: ", lp->lp_ifp->if_xname);
2017         }
2018
2019         va_start(va, fmt);
2020         vprintf(fmt, va);
2021         va_end(va);
2022 }