1*838a4c90Sccardenas /* $OpenBSD: trunklacp.h,v 1.14 2018/08/12 23:50:31 ccardenas Exp $ */ 2a14b8f16Smpf /* $NetBSD: ieee8023ad_impl.h,v 1.2 2005/12/10 23:21:39 elad Exp $ */ 3a14b8f16Smpf 4a14b8f16Smpf /* 5a14b8f16Smpf * Copyright (c)2005 YAMAMOTO Takashi, 6a14b8f16Smpf * All rights reserved. 7a14b8f16Smpf * 8a14b8f16Smpf * Redistribution and use in source and binary forms, with or without 9a14b8f16Smpf * modification, are permitted provided that the following conditions 10a14b8f16Smpf * are met: 11a14b8f16Smpf * 1. Redistributions of source code must retain the above copyright 12a14b8f16Smpf * notice, this list of conditions and the following disclaimer. 13a14b8f16Smpf * 2. Redistributions in binary form must reproduce the above copyright 14a14b8f16Smpf * notice, this list of conditions and the following disclaimer in the 15a14b8f16Smpf * documentation and/or other materials provided with the distribution. 16a14b8f16Smpf * 17a14b8f16Smpf * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18a14b8f16Smpf * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19a14b8f16Smpf * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20a14b8f16Smpf * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21a14b8f16Smpf * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22a14b8f16Smpf * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23a14b8f16Smpf * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24a14b8f16Smpf * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25a14b8f16Smpf * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26a14b8f16Smpf * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27a14b8f16Smpf * SUCH DAMAGE. 28a14b8f16Smpf * 29a14b8f16Smpf * $FreeBSD: src/sys/net/ieee8023ad_lacp.h,v 1.11 2008/03/17 01:26:44 thompsa Exp $ 30a14b8f16Smpf */ 31a14b8f16Smpf 32cca880e4Sderaadt #ifndef _NET_TRUNKLACP_H_ 33cca880e4Sderaadt #define _NET_TRUNKLACP_H_ 34a14b8f16Smpf 35a14b8f16Smpf /* 36c696ac48Smpf * IEEE802.3 slow protocols (on-wire) definitions. 37a14b8f16Smpf * XXX should be elsewhere. 38a14b8f16Smpf */ 39a14b8f16Smpf #define SLOWPROTOCOLS_SUBTYPE_LACP 1 40a14b8f16Smpf #define SLOWPROTOCOLS_SUBTYPE_MARKER 2 41a14b8f16Smpf 42*838a4c90Sccardenas /* 43*838a4c90Sccardenas * default administrative values 44*838a4c90Sccardenas */ 45*838a4c90Sccardenas #define LACP_DEFAULT_MODE 1 /* Active Mode */ 46*838a4c90Sccardenas #define LACP_DEFAULT_TIMEOUT 0 /* Slow Timeout */ 47*838a4c90Sccardenas #define LACP_DEFAULT_SYSTEM_PRIO 0x8000 /* Medium Priority */ 48*838a4c90Sccardenas #define LACP_LOW_SYSTEM_PRIO 0xffff 49*838a4c90Sccardenas #define LACP_HIGH_SYSTEM_PRIO 0x0001 50*838a4c90Sccardenas #define LACP_DEFAULT_PORT_PRIO 0x8000 /* Medium Priority */ 51*838a4c90Sccardenas #define LACP_LOW_PORT_PRIO 0xffff 52*838a4c90Sccardenas #define LACP_HIGH_PORT_PRIO 0x0001 53*838a4c90Sccardenas #define LACP_DEFAULT_IFQ_PRIO 6 54*838a4c90Sccardenas 55a14b8f16Smpf struct slowprothdr { 569eb35c73Smpf u_int8_t sph_subtype; 579eb35c73Smpf u_int8_t sph_version; 58a14b8f16Smpf } __packed; 59a14b8f16Smpf 60c696ac48Smpf /* TLV on-wire structure. */ 61a14b8f16Smpf struct tlvhdr { 629eb35c73Smpf u_int8_t tlv_type; 639eb35c73Smpf u_int8_t tlv_length; 649eb35c73Smpf /* u_int8_t tlv_value[]; */ 65a14b8f16Smpf } __packed; 66a14b8f16Smpf 67c696ac48Smpf /* ... and our implementation. */ 68a14b8f16Smpf #define TLV_SET(tlv, type, length) \ 69a14b8f16Smpf do { \ 70a14b8f16Smpf (tlv)->tlv_type = (type); \ 71a14b8f16Smpf (tlv)->tlv_length = sizeof(*tlv) + (length); \ 72a14b8f16Smpf } while (/*CONSTCOND*/0) 73a14b8f16Smpf 74a14b8f16Smpf struct tlv_template { 759eb35c73Smpf u_int8_t tmpl_type; 769eb35c73Smpf u_int8_t tmpl_length; 77a14b8f16Smpf }; 78a14b8f16Smpf 79a14b8f16Smpf struct lacp_systemid { 809eb35c73Smpf u_int16_t lsi_prio; 819eb35c73Smpf u_int8_t lsi_mac[6]; 82a14b8f16Smpf } __packed; 83a14b8f16Smpf 84a14b8f16Smpf struct lacp_portid { 859eb35c73Smpf u_int16_t lpi_prio; 869eb35c73Smpf u_int16_t lpi_portno; 87a14b8f16Smpf } __packed; 88a14b8f16Smpf 89a14b8f16Smpf struct lacp_peerinfo { 90a14b8f16Smpf struct lacp_systemid lip_systemid; 919eb35c73Smpf u_int16_t lip_key; 92a14b8f16Smpf struct lacp_portid lip_portid; 939eb35c73Smpf u_int8_t lip_state; 949eb35c73Smpf u_int8_t lip_resv[3]; 95a14b8f16Smpf } __packed; 96a14b8f16Smpf 97a14b8f16Smpf struct lacp_collectorinfo { 989eb35c73Smpf u_int16_t lci_maxdelay; 999eb35c73Smpf u_int8_t lci_resv[12]; 100a14b8f16Smpf } __packed; 101a14b8f16Smpf 102a14b8f16Smpf struct lacpdu { 1030ff5889aSmpi struct ether_header ldu_eh; 104a14b8f16Smpf struct slowprothdr ldu_sph; 105a14b8f16Smpf 106a14b8f16Smpf struct tlvhdr ldu_tlv_actor; 107a14b8f16Smpf struct lacp_peerinfo ldu_actor; 108a14b8f16Smpf struct tlvhdr ldu_tlv_partner; 109a14b8f16Smpf struct lacp_peerinfo ldu_partner; 110a14b8f16Smpf struct tlvhdr ldu_tlv_collector; 111a14b8f16Smpf struct lacp_collectorinfo ldu_collector; 112a14b8f16Smpf struct tlvhdr ldu_tlv_term; 1139eb35c73Smpf u_int8_t ldu_resv[50]; 114a14b8f16Smpf } __packed; 115a14b8f16Smpf 116a14b8f16Smpf /* 117c696ac48Smpf * IEEE802.3ad marker protocol (on-wire) definitions. 118a14b8f16Smpf */ 119a14b8f16Smpf struct lacp_markerinfo { 1209eb35c73Smpf u_int16_t mi_rq_port; 1219eb35c73Smpf u_int8_t mi_rq_system[ETHER_ADDR_LEN]; 1229eb35c73Smpf u_int32_t mi_rq_xid; 1239eb35c73Smpf u_int8_t mi_pad[2]; 124a14b8f16Smpf } __packed; 125a14b8f16Smpf 1261743e157Sccardenas #define LACP_STATE_BITS \ 1271743e157Sccardenas "\020" \ 1281743e157Sccardenas "\001ACTIVITY" \ 1291743e157Sccardenas "\002TIMEOUT" \ 1301743e157Sccardenas "\003AGGREGATION" \ 1311743e157Sccardenas "\004SYNC" \ 1321743e157Sccardenas "\005COLLECTING" \ 1331743e157Sccardenas "\006DISTRIBUTING" \ 1341743e157Sccardenas "\007DEFAULTED" \ 1351743e157Sccardenas "\010EXPIRED" 1361743e157Sccardenas 137cca880e4Sderaadt #ifdef _KERNEL 138cca880e4Sderaadt 139cca880e4Sderaadt /* 140cca880e4Sderaadt * IEEE802.3ad LACP implementation details. 141cca880e4Sderaadt */ 142cca880e4Sderaadt #define LACP_TIMER_CURRENT_WHILE 0 143cca880e4Sderaadt #define LACP_TIMER_PERIODIC 1 144cca880e4Sderaadt #define LACP_TIMER_WAIT_WHILE 2 145cca880e4Sderaadt #define LACP_NTIMER 3 146cca880e4Sderaadt 147cca880e4Sderaadt #define LACP_TIMER_ARM(port, timer, val) \ 148cca880e4Sderaadt (port)->lp_timer[(timer)] = (val) 149cca880e4Sderaadt #define LACP_TIMER_DISARM(port, timer) \ 150cca880e4Sderaadt (port)->lp_timer[(timer)] = 0 151cca880e4Sderaadt #define LACP_TIMER_ISARMED(port, timer) \ 152cca880e4Sderaadt ((port)->lp_timer[(timer)] > 0) 153cca880e4Sderaadt 154cca880e4Sderaadt /* 155cca880e4Sderaadt * IEEE802.3ad LACP protocol definitions. 156cca880e4Sderaadt */ 157cca880e4Sderaadt #define LACP_STATE_ACTIVITY (1<<0) 158cca880e4Sderaadt #define LACP_STATE_TIMEOUT (1<<1) 159cca880e4Sderaadt #define LACP_STATE_AGGREGATION (1<<2) 160cca880e4Sderaadt #define LACP_STATE_SYNC (1<<3) 161cca880e4Sderaadt #define LACP_STATE_COLLECTING (1<<4) 162cca880e4Sderaadt #define LACP_STATE_DISTRIBUTING (1<<5) 163cca880e4Sderaadt #define LACP_STATE_DEFAULTED (1<<6) 164cca880e4Sderaadt #define LACP_STATE_EXPIRED (1<<7) 165cca880e4Sderaadt 166cca880e4Sderaadt #define LACP_PORT_NTT 0x00000001 167cca880e4Sderaadt #define LACP_PORT_MARK 0x00000002 168cca880e4Sderaadt 169a14b8f16Smpf struct markerdu { 1700ff5889aSmpi struct ether_header mdu_eh; 171a14b8f16Smpf struct slowprothdr mdu_sph; 172a14b8f16Smpf 173a14b8f16Smpf struct tlvhdr mdu_tlv; 174a14b8f16Smpf struct lacp_markerinfo mdu_info; 175a14b8f16Smpf struct tlvhdr mdu_tlv_term; 1769eb35c73Smpf u_int8_t mdu_resv[90]; 177a14b8f16Smpf } __packed; 178a14b8f16Smpf 179a14b8f16Smpf #define MARKER_TYPE_INFO 0x01 180a14b8f16Smpf #define MARKER_TYPE_RESPONSE 0x02 181a14b8f16Smpf 182a14b8f16Smpf enum lacp_selected { 183a14b8f16Smpf LACP_UNSELECTED, 184a14b8f16Smpf LACP_STANDBY, /* not used in this implementation */ 185a14b8f16Smpf LACP_SELECTED, 186a14b8f16Smpf }; 187a14b8f16Smpf 188a14b8f16Smpf enum lacp_mux_state { 189a14b8f16Smpf LACP_MUX_DETACHED, 190a14b8f16Smpf LACP_MUX_WAITING, 191a14b8f16Smpf LACP_MUX_ATTACHED, 192a14b8f16Smpf LACP_MUX_COLLECTING, 193a14b8f16Smpf LACP_MUX_DISTRIBUTING, 194a14b8f16Smpf }; 195a14b8f16Smpf 196a14b8f16Smpf #define LACP_MAX_PORTS 32 197a14b8f16Smpf 198a14b8f16Smpf struct lacp_portmap { 199a14b8f16Smpf int pm_count; 200a14b8f16Smpf struct lacp_port *pm_map[LACP_MAX_PORTS]; 201a14b8f16Smpf }; 202a14b8f16Smpf 203a14b8f16Smpf struct lacp_port { 204a14b8f16Smpf TAILQ_ENTRY(lacp_port) lp_dist_q; 205a14b8f16Smpf LIST_ENTRY(lacp_port) lp_next; 206a14b8f16Smpf struct lacp_softc *lp_lsc; 207a14b8f16Smpf struct trunk_port *lp_trunk; 208a14b8f16Smpf struct ifnet *lp_ifp; 209a14b8f16Smpf struct lacp_peerinfo lp_partner; 210a14b8f16Smpf struct lacp_peerinfo lp_actor; 211a14b8f16Smpf struct lacp_markerinfo lp_marker; 212a14b8f16Smpf #define lp_state lp_actor.lip_state 213a14b8f16Smpf #define lp_key lp_actor.lip_key 214a14b8f16Smpf #define lp_systemid lp_actor.lip_systemid 215a14b8f16Smpf struct timeval lp_last_lacpdu; 216a14b8f16Smpf int lp_lacpdu_sent; 217a14b8f16Smpf enum lacp_mux_state lp_mux_state; 218a14b8f16Smpf enum lacp_selected lp_selected; 219a14b8f16Smpf int lp_flags; 220a14b8f16Smpf u_int lp_media; /* XXX redundant */ 221a14b8f16Smpf int lp_timer[LACP_NTIMER]; 22232f1989bSmikeb struct mbuf_queue lp_mq; 223a14b8f16Smpf 224a14b8f16Smpf struct lacp_aggregator *lp_aggregator; 225a14b8f16Smpf }; 226a14b8f16Smpf 227a14b8f16Smpf struct lacp_aggregator { 228a14b8f16Smpf TAILQ_ENTRY(lacp_aggregator) la_q; 229a14b8f16Smpf int la_refcnt; /* num of ports which selected us */ 230a14b8f16Smpf int la_nports; /* num of distributing ports */ 231a14b8f16Smpf TAILQ_HEAD(, lacp_port) la_ports; /* distributing ports */ 232a14b8f16Smpf struct lacp_peerinfo la_partner; 233a14b8f16Smpf struct lacp_peerinfo la_actor; 234a14b8f16Smpf int la_pending; /* number of ports in wait_while */ 235a14b8f16Smpf }; 236a14b8f16Smpf 237*838a4c90Sccardenas struct lacp_admin_def { 238*838a4c90Sccardenas u_int8_t lad_mode; /* active or passive */ 239*838a4c90Sccardenas u_int8_t lad_timeout; /* fast or slow */ 240*838a4c90Sccardenas u_int16_t lad_prio; /* system priority */ 241*838a4c90Sccardenas u_int16_t lad_portprio; /* port priority */ 242*838a4c90Sccardenas u_int8_t lad_ifqprio; /* ifq priority */ 243*838a4c90Sccardenas }; 244*838a4c90Sccardenas 245a14b8f16Smpf struct lacp_softc { 246a14b8f16Smpf struct trunk_softc *lsc_softc; 247a14b8f16Smpf struct lacp_aggregator *lsc_active_aggregator; 248a14b8f16Smpf TAILQ_HEAD(, lacp_aggregator) lsc_aggregators; 249a14b8f16Smpf int lsc_suppress_distributing; 250a14b8f16Smpf struct timeout lsc_transit_callout; 251a14b8f16Smpf struct timeout lsc_callout; 252a14b8f16Smpf LIST_HEAD(, lacp_port) lsc_ports; 253a14b8f16Smpf struct lacp_portmap lsc_pmap[2]; 254a14b8f16Smpf volatile u_int lsc_activemap; 255fcf4ed95Stedu SIPHASH_KEY lsc_hashkey; 25632f1989bSmikeb struct task lsc_input; 257*838a4c90Sccardenas struct lacp_admin_def lsc_admin_defaults; 258*838a4c90Sccardenas #define lsc_mode lsc_admin_defaults.lad_mode 259*838a4c90Sccardenas #define lsc_timeout lsc_admin_defaults.lad_timeout 260*838a4c90Sccardenas #define lsc_sys_prio lsc_admin_defaults.lad_prio 261*838a4c90Sccardenas #define lsc_port_prio lsc_admin_defaults.lad_portprio 262*838a4c90Sccardenas #define lsc_ifq_prio lsc_admin_defaults.lad_ifqprio 263a14b8f16Smpf }; 264a14b8f16Smpf 265a14b8f16Smpf #define LACP_TYPE_ACTORINFO 1 266a14b8f16Smpf #define LACP_TYPE_PARTNERINFO 2 267a14b8f16Smpf #define LACP_TYPE_COLLECTORINFO 3 268a14b8f16Smpf 269a14b8f16Smpf /* timeout values (in sec) */ 270a14b8f16Smpf #define LACP_FAST_PERIODIC_TIME (1) 271a14b8f16Smpf #define LACP_SLOW_PERIODIC_TIME (30) 272a14b8f16Smpf #define LACP_SHORT_TIMEOUT_TIME (3 * LACP_FAST_PERIODIC_TIME) 273a14b8f16Smpf #define LACP_LONG_TIMEOUT_TIME (3 * LACP_SLOW_PERIODIC_TIME) 274a14b8f16Smpf #define LACP_CHURN_DETECTION_TIME (60) 275a14b8f16Smpf #define LACP_AGGREGATE_WAIT_TIME (2) 276a14b8f16Smpf #define LACP_TRANSIT_DELAY 3000 /* in msec */ 277a14b8f16Smpf 278a14b8f16Smpf #define LACP_STATE_EQ(s1, s2, mask) \ 279a14b8f16Smpf ((((s1) ^ (s2)) & (mask)) == 0) 280a14b8f16Smpf 281a14b8f16Smpf #define LACP_SYS_PRI(peer) (peer).lip_systemid.lsi_prio 282a14b8f16Smpf 283a14b8f16Smpf #define LACP_PORT(_lp) ((struct lacp_port *)(_lp)->tp_psc) 284a14b8f16Smpf #define LACP_SOFTC(_sc) ((struct lacp_softc *)(_sc)->tr_psc) 285a14b8f16Smpf 2860ff5889aSmpi int lacp_input(struct trunk_port *, struct mbuf *); 287a14b8f16Smpf struct trunk_port *lacp_select_tx_port(struct trunk_softc *, struct mbuf *); 288a14b8f16Smpf int lacp_attach(struct trunk_softc *); 289a14b8f16Smpf int lacp_detach(struct trunk_softc *); 290a14b8f16Smpf void lacp_init(struct trunk_softc *); 291a14b8f16Smpf void lacp_stop(struct trunk_softc *); 292a14b8f16Smpf int lacp_port_create(struct trunk_port *); 293a14b8f16Smpf void lacp_port_destroy(struct trunk_port *); 294a14b8f16Smpf void lacp_linkstate(struct trunk_port *); 295a14b8f16Smpf void lacp_req(struct trunk_softc *, caddr_t); 296a14b8f16Smpf void lacp_portreq(struct trunk_port *, caddr_t); 297de7ec0f8Sreyk u_int lacp_port_status(struct trunk_port *); 298a14b8f16Smpf 299a14b8f16Smpf /* following constants don't include terminating NUL */ 300a14b8f16Smpf #define LACP_MACSTR_MAX (2*6 + 5) 301a14b8f16Smpf #define LACP_SYSTEMPRIOSTR_MAX (4) 302a14b8f16Smpf #define LACP_SYSTEMIDSTR_MAX (LACP_SYSTEMPRIOSTR_MAX + 1 + LACP_MACSTR_MAX) 303a14b8f16Smpf #define LACP_PORTPRIOSTR_MAX (4) 304a14b8f16Smpf #define LACP_PORTNOSTR_MAX (4) 305a14b8f16Smpf #define LACP_PORTIDSTR_MAX (LACP_PORTPRIOSTR_MAX + 1 + LACP_PORTNOSTR_MAX) 306a14b8f16Smpf #define LACP_KEYSTR_MAX (4) 307a14b8f16Smpf #define LACP_PARTNERSTR_MAX \ 308a14b8f16Smpf (1 + LACP_SYSTEMIDSTR_MAX + 1 + LACP_KEYSTR_MAX + 1 \ 309a14b8f16Smpf + LACP_PORTIDSTR_MAX + 1) 310a14b8f16Smpf #define LACP_LAGIDSTR_MAX \ 311a14b8f16Smpf (1 + LACP_PARTNERSTR_MAX + 1 + LACP_PARTNERSTR_MAX + 1) 312a14b8f16Smpf #define LACP_STATESTR_MAX (255) /* XXX */ 313cca880e4Sderaadt 314cca880e4Sderaadt #endif /* _KERNEL */ 315cca880e4Sderaadt 316cca880e4Sderaadt #endif /* _NET_TRUNKLACP_H_ */ 317