1 /* $NetBSD: ieee8023ad_impl.h,v 1.2 2005/12/10 23:21:39 elad Exp $ */ 2 3 /*- 4 * Copyright (c)2005 YAMAMOTO Takashi, 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 /* 32 * IEEE802.3ad LACP 33 * 34 * implementation details. 35 */ 36 37 #define LACP_TIMER_CURRENT_WHILE 0 38 #define LACP_TIMER_PERIODIC 1 39 #define LACP_TIMER_WAIT_WHILE 2 40 #define LACP_NTIMER 3 41 42 #define LACP_TIMER_ARM(port, timer, val) \ 43 (port)->lp_timer[(timer)] = (val) 44 #define LACP_TIMER_DISARM(port, timer) \ 45 (port)->lp_timer[(timer)] = 0 46 #define LACP_TIMER_ISARMED(port, timer) \ 47 ((port)->lp_timer[(timer)] > 0) 48 49 /* 50 * IEEE802.3ad LACP 51 * 52 * protocol definitions. 53 */ 54 55 #define LACP_STATE_ACTIVITY (1<<0) 56 #define LACP_STATE_TIMEOUT (1<<1) 57 #define LACP_STATE_AGGREGATION (1<<2) 58 #define LACP_STATE_SYNC (1<<3) 59 #define LACP_STATE_COLLECTING (1<<4) 60 #define LACP_STATE_DISTRIBUTING (1<<5) 61 #define LACP_STATE_DEFAULTED (1<<6) 62 #define LACP_STATE_EXPIRED (1<<7) 63 64 #define LACP_PORT_NTT 0x00000001 65 #define LACP_PORT_PROMISC 0x00000004 66 #define LACP_PORT_LADDRCHANGED 0x00000008 67 #define LACP_PORT_ATTACHED 0x00000010 68 #define LACP_PORT_LARVAL 0x00000020 69 #define LACP_PORT_DETACHING 0x00000040 70 71 #define LACP_STATE_BITS \ 72 "\020" \ 73 "\001ACTIVITY" \ 74 "\002TIMEOUT" \ 75 "\003AGGREGATION" \ 76 "\004SYNC" \ 77 "\005COLLECTING" \ 78 "\006DISTRIBUTING" \ 79 "\007DEFAULTED" \ 80 "\010EXPIRED" 81 82 /* 83 * IEEE802.3 slow protocols 84 * 85 * protocol (on-wire) definitions. 86 * 87 * XXX should be elsewhere. 88 */ 89 90 #define SLOWPROTOCOLS_SUBTYPE_LACP 1 91 #define SLOWPROTOCOLS_SUBTYPE_MARKER 2 92 93 struct slowprothdr { 94 uint8_t sph_subtype; 95 uint8_t sph_version; 96 } __packed; 97 98 /* 99 * TLV on-wire structure. 100 */ 101 102 struct tlvhdr { 103 uint8_t tlv_type; 104 uint8_t tlv_length; 105 /* uint8_t tlv_value[]; */ 106 } __packed; 107 108 /* 109 * ... and our implementation. 110 */ 111 112 #define TLV_SET(tlv, type, length) \ 113 do { \ 114 (tlv)->tlv_type = (type); \ 115 (tlv)->tlv_length = sizeof(*tlv) + (length); \ 116 } while (/*CONSTCOND*/0) 117 118 struct tlv_template { 119 uint8_t tmpl_type; 120 uint8_t tmpl_length; 121 }; 122 123 struct lacp_systemid { 124 uint16_t lsi_prio; 125 uint8_t lsi_mac[6]; 126 } __packed; 127 128 struct lacp_portid { 129 uint16_t lpi_prio; 130 uint16_t lpi_portno; 131 } __packed; 132 133 struct lacp_peerinfo { 134 struct lacp_systemid lip_systemid; 135 uint16_t lip_key; 136 struct lacp_portid lip_portid; 137 uint8_t lip_state; 138 uint8_t lip_resv[3]; 139 } __packed; 140 141 struct lacp_collectorinfo { 142 uint16_t lci_maxdelay; 143 uint8_t lci_resv[12]; 144 } __packed; 145 146 struct lacpdu { 147 struct ether_header ldu_eh; 148 struct slowprothdr ldu_sph; 149 150 struct tlvhdr ldu_tlv_actor; 151 struct lacp_peerinfo ldu_actor; 152 struct tlvhdr ldu_tlv_partner; 153 struct lacp_peerinfo ldu_partner; 154 struct tlvhdr ldu_tlv_collector; 155 struct lacp_collectorinfo ldu_collector; 156 struct tlvhdr ldu_tlv_term; 157 uint8_t ldu_resv[50]; 158 } __packed; 159 160 #define LACP_TRANSIT_DELAY 1000 /* in msec */ 161 162 enum lacp_selected { 163 LACP_UNSELECTED, 164 LACP_STANDBY, /* not used in this implementation */ 165 LACP_SELECTED, 166 }; 167 168 enum lacp_mux_state { 169 LACP_MUX_DETACHED, 170 LACP_MUX_WAITING, 171 LACP_MUX_ATTACHED, 172 LACP_MUX_COLLECTING, 173 LACP_MUX_DISTRIBUTING, 174 }; 175 176 struct lacp_port { 177 TAILQ_ENTRY(lacp_port) lp_dist_q; 178 LIST_ENTRY(lacp_port) lp_next; 179 struct lacp_softc *lp_lsc; 180 struct lagg_port *lp_lagg; 181 struct ifnet *lp_ifp; 182 struct lacp_peerinfo lp_partner; 183 struct lacp_peerinfo lp_actor; 184 #define lp_state lp_actor.lip_state 185 #define lp_key lp_actor.lip_key 186 struct timeval lp_last_lacpdu; 187 int lp_lacpdu_sent; 188 enum lacp_mux_state lp_mux_state; 189 enum lacp_selected lp_selected; 190 int lp_flags; 191 u_int lp_media; /* XXX redundant */ 192 int lp_timer[LACP_NTIMER]; 193 194 struct lacp_aggregator *lp_aggregator; 195 }; 196 197 struct lacp_aggregator { 198 TAILQ_ENTRY(lacp_aggregator) la_q; 199 int la_refcnt; /* num of ports which selected us */ 200 int la_nports; /* num of distributing ports */ 201 TAILQ_HEAD(, lacp_port) la_ports; /* distributing ports */ 202 struct lacp_peerinfo la_partner; 203 struct lacp_peerinfo la_actor; 204 int la_pending; /* number of ports which is waiting wait_while */ 205 }; 206 207 struct lacp_softc { 208 struct lagg_softc *lsc_lagg; 209 struct lacp_aggregator *lsc_active_aggregator; 210 TAILQ_HEAD(, lacp_aggregator) lsc_aggregators; 211 boolean_t lsc_suppress_distributing; 212 struct callout lsc_transit_callout; 213 struct callout lsc_callout; 214 LIST_HEAD(, lacp_port) lsc_ports; 215 u_int32_t lsc_hashkey; 216 }; 217 218 #define LACP_TYPE_ACTORINFO 1 219 #define LACP_TYPE_PARTNERINFO 2 220 #define LACP_TYPE_COLLECTORINFO 3 221 222 /* timeout values (in sec) */ 223 #define LACP_FAST_PERIODIC_TIME (1) 224 #define LACP_SLOW_PERIODIC_TIME (30) 225 #define LACP_SHORT_TIMEOUT_TIME (3 * LACP_FAST_PERIODIC_TIME) 226 #define LACP_LONG_TIMEOUT_TIME (3 * LACP_SLOW_PERIODIC_TIME) 227 #define LACP_CHURN_DETECTION_TIME (60) 228 #define LACP_AGGREGATE_WAIT_TIME (2) 229 230 /* 231 int tlv_check(const void *, size_t, const struct tlvhdr *, 232 const struct tlv_template *, boolean_t); 233 */ 234 235 /* 236 * IEEE802.3ad marker protocol 237 * 238 * protocol (on-wire) definitions. 239 */ 240 241 struct markerdu { 242 struct ether_header mdu_eh; 243 struct slowprothdr mdu_sph; 244 245 struct tlvhdr mdu_tlv; 246 uint16_t mdu_rq_port; 247 uint8_t mdu_rq_system[6]; 248 uint8_t mdu_rq_xid[4]; 249 uint8_t mdu_pad[2]; 250 251 struct tlvhdr mdu_tlv_term; 252 uint8_t mdu_resv[90]; 253 } __packed; 254 255 #define MARKER_TYPE_INFO 1 256 #define MARKER_TYPE_RESPONSE 2 257 258 #define LACP_STATE_EQ(s1, s2, mask) \ 259 ((((s1) ^ (s2)) & (mask)) == 0) 260 261 #define LACP_PORT(_lp) ((struct lacp_port *)(_lp)->lp_psc) 262 #define LACP_SOFTC(_sc) ((struct lacp_softc *)(_sc)->sc_psc) 263 264 int lacp_input(struct lagg_port *, struct mbuf *); 265 int lacp_marker_input(struct lagg_port *, struct mbuf *); 266 struct lagg_port *lacp_select_tx_port(struct lagg_softc *, struct mbuf *); 267 int lacp_attach(struct lagg_softc *); 268 int lacp_detach(struct lagg_softc *); 269 void lacp_init(struct lagg_softc *); 270 void lacp_stop(struct lagg_softc *); 271 int lacp_port_create(struct lagg_port *); 272 void lacp_port_destroy(struct lagg_port *); 273 void lacp_linkstate(struct lagg_port *); 274 int lacp_port_isactive(struct lagg_port *); 275 276 /* following constants don't include terminating NUL */ 277 #define LACP_MACSTR_MAX (2*6 + 5) 278 #define LACP_SYSTEMPRIOSTR_MAX (4) 279 #define LACP_SYSTEMIDSTR_MAX (LACP_SYSTEMPRIOSTR_MAX + 1 + LACP_MACSTR_MAX) 280 #define LACP_PORTPRIOSTR_MAX (4) 281 #define LACP_PORTNOSTR_MAX (4) 282 #define LACP_PORTIDSTR_MAX (LACP_PORTPRIOSTR_MAX + 1 + LACP_PORTNOSTR_MAX) 283 #define LACP_KEYSTR_MAX (4) 284 #define LACP_PARTNERSTR_MAX \ 285 (1 + LACP_SYSTEMIDSTR_MAX + 1 + LACP_KEYSTR_MAX + 1 \ 286 + LACP_PORTIDSTR_MAX + 1) 287 #define LACP_LAGIDSTR_MAX \ 288 (1 + LACP_PARTNERSTR_MAX + 1 + LACP_PARTNERSTR_MAX + 1) 289 #define LACP_STATESTR_MAX (255) /* XXX */ 290