ieee8023ad_lacp.h revision 169739
180016Sobrien/* $NetBSD: ieee8023ad_impl.h,v 1.2 2005/12/10 23:21:39 elad Exp $ */ 280016Sobrien 380016Sobrien/*- 480016Sobrien * Copyright (c)2005 YAMAMOTO Takashi, 580016Sobrien * All rights reserved. 680016Sobrien * 7218822Sdim * Redistribution and use in source and binary forms, with or without 8218822Sdim * modification, are permitted provided that the following conditions 9218822Sdim * are met: 10218822Sdim * 1. Redistributions of source code must retain the above copyright 11218822Sdim * notice, this list of conditions and the following disclaimer. 12218822Sdim * 2. Redistributions in binary form must reproduce the above copyright 1380016Sobrien * notice, this list of conditions and the following disclaimer in the 1480016Sobrien * documentation and/or other materials provided with the distribution. 1580016Sobrien * 16130561Sobrien * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1780016Sobrien * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1880016Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1980016Sobrien * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2080016Sobrien * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2180016Sobrien * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2280016Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2380016Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2480016Sobrien * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2580016Sobrien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2680016Sobrien * SUCH DAMAGE. 2780016Sobrien * 28218822Sdim * $FreeBSD: head/sys/net/ieee8023ad_lacp.h 169739 2007-05-19 07:47:04Z thompsa $ 2989857Sobrien */ 3080016Sobrien 3180016Sobrien/* 3280016Sobrien * IEEE802.3ad LACP 33130561Sobrien * 34130561Sobrien * implementation details. 3589857Sobrien */ 3689857Sobrien 3789857Sobrien#define LACP_TIMER_CURRENT_WHILE 0 3880016Sobrien#define LACP_TIMER_PERIODIC 1 39218822Sdim#define LACP_TIMER_WAIT_WHILE 2 40218822Sdim#define LACP_NTIMER 3 4180016Sobrien 42218822Sdim#define LACP_TIMER_ARM(port, timer, val) \ 43218822Sdim (port)->lp_timer[(timer)] = (val) 4480016Sobrien#define LACP_TIMER_DISARM(port, timer) \ 45218822Sdim (port)->lp_timer[(timer)] = 0 4680016Sobrien#define LACP_TIMER_ISARMED(port, timer) \ 4780016Sobrien ((port)->lp_timer[(timer)] > 0) 4880016Sobrien 4980016Sobrien/* 50218822Sdim * IEEE802.3ad LACP 5180016Sobrien * 5280016Sobrien * protocol definitions. 5380016Sobrien */ 54218822Sdim 55218822Sdim#define LACP_STATE_ACTIVITY (1<<0) 56218822Sdim#define LACP_STATE_TIMEOUT (1<<1) 57218822Sdim#define LACP_STATE_AGGREGATION (1<<2) 58218822Sdim#define LACP_STATE_SYNC (1<<3) 5980016Sobrien#define LACP_STATE_COLLECTING (1<<4) 60218822Sdim#define LACP_STATE_DISTRIBUTING (1<<5) 61218822Sdim#define LACP_STATE_DEFAULTED (1<<6) 6280016Sobrien#define LACP_STATE_EXPIRED (1<<7) 6380016Sobrien 6480016Sobrien#define LACP_PORT_NTT 0x00000001 6580016Sobrien#define LACP_PORT_MARK 0x00000002 6689857Sobrien#define LACP_PORT_PROMISC 0x00000004 6780016Sobrien#define LACP_PORT_LADDRCHANGED 0x00000008 6880016Sobrien#define LACP_PORT_ATTACHED 0x00000010 6980016Sobrien#define LACP_PORT_LARVAL 0x00000020 7080016Sobrien#define LACP_PORT_DETACHING 0x00000040 7180016Sobrien 7280016Sobrien#define LACP_STATE_BITS \ 7389857Sobrien "\020" \ 7489857Sobrien "\001ACTIVITY" \ 7589857Sobrien "\002TIMEOUT" \ 7689857Sobrien "\003AGGREGATION" \ 7780016Sobrien "\004SYNC" \ 7880016Sobrien "\005COLLECTING" \ 7980016Sobrien "\006DISTRIBUTING" \ 8080016Sobrien "\007DEFAULTED" \ 81218822Sdim "\010EXPIRED" 8280016Sobrien 8380016Sobrien/* 8480016Sobrien * IEEE802.3 slow protocols 8580016Sobrien * 8680016Sobrien * protocol (on-wire) definitions. 8780016Sobrien * 8880016Sobrien * XXX should be elsewhere. 8980016Sobrien */ 9080016Sobrien 9180016Sobrien#define SLOWPROTOCOLS_SUBTYPE_LACP 1 9280016Sobrien#define SLOWPROTOCOLS_SUBTYPE_MARKER 2 9380016Sobrien 9480016Sobrienstruct slowprothdr { 9580016Sobrien uint8_t sph_subtype; 9680016Sobrien uint8_t sph_version; 9780016Sobrien} __packed; 9880016Sobrien 9980016Sobrien/* 10080016Sobrien * TLV on-wire structure. 101218822Sdim */ 102218822Sdim 103218822Sdimstruct tlvhdr { 104218822Sdim uint8_t tlv_type; 10580016Sobrien uint8_t tlv_length; 106218822Sdim /* uint8_t tlv_value[]; */ 107218822Sdim} __packed; 108218822Sdim 109218822Sdim/* 110218822Sdim * ... and our implementation. 111218822Sdim */ 112218822Sdim 11380016Sobrien#define TLV_SET(tlv, type, length) \ 11480016Sobrien do { \ 11580016Sobrien (tlv)->tlv_type = (type); \ 11680016Sobrien (tlv)->tlv_length = sizeof(*tlv) + (length); \ 11780016Sobrien } while (/*CONSTCOND*/0) 11880016Sobrien 11980016Sobrienstruct tlv_template { 12080016Sobrien uint8_t tmpl_type; 12180016Sobrien uint8_t tmpl_length; 12280016Sobrien}; 123 124struct lacp_systemid { 125 uint16_t lsi_prio; 126 uint8_t lsi_mac[6]; 127} __packed; 128 129struct lacp_portid { 130 uint16_t lpi_prio; 131 uint16_t lpi_portno; 132} __packed; 133 134struct lacp_peerinfo { 135 struct lacp_systemid lip_systemid; 136 uint16_t lip_key; 137 struct lacp_portid lip_portid; 138 uint8_t lip_state; 139 uint8_t lip_resv[3]; 140} __packed; 141 142struct lacp_collectorinfo { 143 uint16_t lci_maxdelay; 144 uint8_t lci_resv[12]; 145} __packed; 146 147struct lacpdu { 148 struct ether_header ldu_eh; 149 struct slowprothdr ldu_sph; 150 151 struct tlvhdr ldu_tlv_actor; 152 struct lacp_peerinfo ldu_actor; 153 struct tlvhdr ldu_tlv_partner; 154 struct lacp_peerinfo ldu_partner; 155 struct tlvhdr ldu_tlv_collector; 156 struct lacp_collectorinfo ldu_collector; 157 struct tlvhdr ldu_tlv_term; 158 uint8_t ldu_resv[50]; 159} __packed; 160 161/* 162 * IEEE802.3ad marker protocol 163 * 164 * protocol (on-wire) definitions. 165 */ 166struct lacp_markerinfo { 167 uint16_t mi_rq_port; 168 uint8_t mi_rq_system[ETHER_ADDR_LEN]; 169 uint32_t mi_rq_xid; 170 uint8_t mi_pad[2]; 171} __packed; 172 173struct markerdu { 174 struct ether_header mdu_eh; 175 struct slowprothdr mdu_sph; 176 177 struct tlvhdr mdu_tlv; 178 struct lacp_markerinfo mdu_info; 179 struct tlvhdr mdu_tlv_term; 180 uint8_t mdu_resv[90]; 181} __packed; 182 183#define MARKER_TYPE_INFO 0x01 184#define MARKER_TYPE_RESPONSE 0x02 185 186enum lacp_selected { 187 LACP_UNSELECTED, 188 LACP_STANDBY, /* not used in this implementation */ 189 LACP_SELECTED, 190}; 191 192enum lacp_mux_state { 193 LACP_MUX_DETACHED, 194 LACP_MUX_WAITING, 195 LACP_MUX_ATTACHED, 196 LACP_MUX_COLLECTING, 197 LACP_MUX_DISTRIBUTING, 198}; 199 200struct lacp_port { 201 TAILQ_ENTRY(lacp_port) lp_dist_q; 202 LIST_ENTRY(lacp_port) lp_next; 203 struct lacp_softc *lp_lsc; 204 struct lagg_port *lp_lagg; 205 struct ifnet *lp_ifp; 206 struct lacp_peerinfo lp_partner; 207 struct lacp_peerinfo lp_actor; 208 struct lacp_markerinfo lp_marker; 209#define lp_state lp_actor.lip_state 210#define lp_key lp_actor.lip_key 211#define lp_systemid lp_actor.lip_systemid 212 struct timeval lp_last_lacpdu; 213 int lp_lacpdu_sent; 214 enum lacp_mux_state lp_mux_state; 215 enum lacp_selected lp_selected; 216 int lp_flags; 217 u_int lp_media; /* XXX redundant */ 218 int lp_timer[LACP_NTIMER]; 219 struct ifmultiaddr *lp_ifma; 220 221 struct lacp_aggregator *lp_aggregator; 222}; 223 224struct lacp_aggregator { 225 TAILQ_ENTRY(lacp_aggregator) la_q; 226 int la_refcnt; /* num of ports which selected us */ 227 int la_nports; /* num of distributing ports */ 228 TAILQ_HEAD(, lacp_port) la_ports; /* distributing ports */ 229 struct lacp_peerinfo la_partner; 230 struct lacp_peerinfo la_actor; 231 int la_pending; /* number of ports which is waiting wait_while */ 232}; 233 234struct lacp_softc { 235 struct lagg_softc *lsc_lagg; 236 struct lacp_aggregator *lsc_active_aggregator; 237 TAILQ_HEAD(, lacp_aggregator) lsc_aggregators; 238 boolean_t lsc_suppress_distributing; 239 struct callout lsc_transit_callout; 240 struct callout lsc_callout; 241 LIST_HEAD(, lacp_port) lsc_ports; 242 u_int32_t lsc_hashkey; 243 struct task lsc_qtask; 244 struct ifqueue lsc_queue; /* pdu input queue */ 245}; 246 247#define LACP_TYPE_ACTORINFO 1 248#define LACP_TYPE_PARTNERINFO 2 249#define LACP_TYPE_COLLECTORINFO 3 250 251/* timeout values (in sec) */ 252#define LACP_FAST_PERIODIC_TIME (1) 253#define LACP_SLOW_PERIODIC_TIME (30) 254#define LACP_SHORT_TIMEOUT_TIME (3 * LACP_FAST_PERIODIC_TIME) 255#define LACP_LONG_TIMEOUT_TIME (3 * LACP_SLOW_PERIODIC_TIME) 256#define LACP_CHURN_DETECTION_TIME (60) 257#define LACP_AGGREGATE_WAIT_TIME (2) 258#define LACP_TRANSIT_DELAY 3000 /* in msec */ 259 260/* 261int tlv_check(const void *, size_t, const struct tlvhdr *, 262 const struct tlv_template *, boolean_t); 263*/ 264 265#define LACP_STATE_EQ(s1, s2, mask) \ 266 ((((s1) ^ (s2)) & (mask)) == 0) 267 268#define LACP_PORT(_lp) ((struct lacp_port *)(_lp)->lp_psc) 269#define LACP_SOFTC(_sc) ((struct lacp_softc *)(_sc)->sc_psc) 270 271void lacp_input(struct lagg_port *, struct mbuf *); 272struct lagg_port *lacp_select_tx_port(struct lagg_softc *, struct mbuf *); 273int lacp_attach(struct lagg_softc *); 274int lacp_detach(struct lagg_softc *); 275void lacp_init(struct lagg_softc *); 276void lacp_stop(struct lagg_softc *); 277int lacp_port_create(struct lagg_port *); 278void lacp_port_destroy(struct lagg_port *); 279void lacp_linkstate(struct lagg_port *); 280int lacp_port_isactive(struct lagg_port *); 281 282/* following constants don't include terminating NUL */ 283#define LACP_MACSTR_MAX (2*6 + 5) 284#define LACP_SYSTEMPRIOSTR_MAX (4) 285#define LACP_SYSTEMIDSTR_MAX (LACP_SYSTEMPRIOSTR_MAX + 1 + LACP_MACSTR_MAX) 286#define LACP_PORTPRIOSTR_MAX (4) 287#define LACP_PORTNOSTR_MAX (4) 288#define LACP_PORTIDSTR_MAX (LACP_PORTPRIOSTR_MAX + 1 + LACP_PORTNOSTR_MAX) 289#define LACP_KEYSTR_MAX (4) 290#define LACP_PARTNERSTR_MAX \ 291 (1 + LACP_SYSTEMIDSTR_MAX + 1 + LACP_KEYSTR_MAX + 1 \ 292 + LACP_PORTIDSTR_MAX + 1) 293#define LACP_LAGIDSTR_MAX \ 294 (1 + LACP_PARTNERSTR_MAX + 1 + LACP_PARTNERSTR_MAX + 1) 295#define LACP_STATESTR_MAX (255) /* XXX */ 296