Linux 4.16.11
[linux/fpc-iii.git] / drivers / net / bonding / bond_3ad.c
blobf43fb2f958a54e12c4d29ad91340e237e9d98e5a
1 /*
2 * Copyright(c) 1999 - 2004 Intel Corporation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
7 * any later version.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59
16 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 * The full GNU General Public License is included in this distribution in the
19 * file called LICENSE.
23 #include <linux/skbuff.h>
24 #include <linux/if_ether.h>
25 #include <linux/netdevice.h>
26 #include <linux/spinlock.h>
27 #include <linux/ethtool.h>
28 #include <linux/etherdevice.h>
29 #include <linux/if_bonding.h>
30 #include <linux/pkt_sched.h>
31 #include <net/net_namespace.h>
32 #include <net/bonding.h>
33 #include <net/bond_3ad.h>
35 /* General definitions */
36 #define AD_SHORT_TIMEOUT 1
37 #define AD_LONG_TIMEOUT 0
38 #define AD_STANDBY 0x2
39 #define AD_MAX_TX_IN_SECOND 3
40 #define AD_COLLECTOR_MAX_DELAY 0
42 /* Timer definitions (43.4.4 in the 802.3ad standard) */
43 #define AD_FAST_PERIODIC_TIME 1
44 #define AD_SLOW_PERIODIC_TIME 30
45 #define AD_SHORT_TIMEOUT_TIME (3*AD_FAST_PERIODIC_TIME)
46 #define AD_LONG_TIMEOUT_TIME (3*AD_SLOW_PERIODIC_TIME)
47 #define AD_CHURN_DETECTION_TIME 60
48 #define AD_AGGREGATE_WAIT_TIME 2
50 /* Port state definitions (43.4.2.2 in the 802.3ad standard) */
51 #define AD_STATE_LACP_ACTIVITY 0x1
52 #define AD_STATE_LACP_TIMEOUT 0x2
53 #define AD_STATE_AGGREGATION 0x4
54 #define AD_STATE_SYNCHRONIZATION 0x8
55 #define AD_STATE_COLLECTING 0x10
56 #define AD_STATE_DISTRIBUTING 0x20
57 #define AD_STATE_DEFAULTED 0x40
58 #define AD_STATE_EXPIRED 0x80
60 /* Port Variables definitions used by the State Machines (43.4.7 in the
61 * 802.3ad standard)
63 #define AD_PORT_BEGIN 0x1
64 #define AD_PORT_LACP_ENABLED 0x2
65 #define AD_PORT_ACTOR_CHURN 0x4
66 #define AD_PORT_PARTNER_CHURN 0x8
67 #define AD_PORT_READY 0x10
68 #define AD_PORT_READY_N 0x20
69 #define AD_PORT_MATCHED 0x40
70 #define AD_PORT_STANDBY 0x80
71 #define AD_PORT_SELECTED 0x100
72 #define AD_PORT_MOVED 0x200
73 #define AD_PORT_CHURNED (AD_PORT_ACTOR_CHURN | AD_PORT_PARTNER_CHURN)
75 /* Port Key definitions
76 * key is determined according to the link speed, duplex and
77 * user key (which is yet not supported)
78 * --------------------------------------------------------------
79 * Port key | User key (10 bits) | Speed (5 bits) | Duplex|
80 * --------------------------------------------------------------
81 * |15 6|5 1|0
83 #define AD_DUPLEX_KEY_MASKS 0x1
84 #define AD_SPEED_KEY_MASKS 0x3E
85 #define AD_USER_KEY_MASKS 0xFFC0
87 enum ad_link_speed_type {
88 AD_LINK_SPEED_1MBPS = 1,
89 AD_LINK_SPEED_10MBPS,
90 AD_LINK_SPEED_100MBPS,
91 AD_LINK_SPEED_1000MBPS,
92 AD_LINK_SPEED_2500MBPS,
93 AD_LINK_SPEED_5000MBPS,
94 AD_LINK_SPEED_10000MBPS,
95 AD_LINK_SPEED_14000MBPS,
96 AD_LINK_SPEED_20000MBPS,
97 AD_LINK_SPEED_25000MBPS,
98 AD_LINK_SPEED_40000MBPS,
99 AD_LINK_SPEED_50000MBPS,
100 AD_LINK_SPEED_56000MBPS,
101 AD_LINK_SPEED_100000MBPS,
104 /* compare MAC addresses */
105 #define MAC_ADDRESS_EQUAL(A, B) \
106 ether_addr_equal_64bits((const u8 *)A, (const u8 *)B)
108 static const u8 null_mac_addr[ETH_ALEN + 2] __long_aligned = {
109 0, 0, 0, 0, 0, 0
111 static u16 ad_ticks_per_sec;
112 static const int ad_delta_in_ticks = (AD_TIMER_INTERVAL * HZ) / 1000;
114 static const u8 lacpdu_mcast_addr[ETH_ALEN + 2] __long_aligned =
115 MULTICAST_LACPDU_ADDR;
117 /* ================= main 802.3ad protocol functions ================== */
118 static int ad_lacpdu_send(struct port *port);
119 static int ad_marker_send(struct port *port, struct bond_marker *marker);
120 static void ad_mux_machine(struct port *port, bool *update_slave_arr);
121 static void ad_rx_machine(struct lacpdu *lacpdu, struct port *port);
122 static void ad_tx_machine(struct port *port);
123 static void ad_periodic_machine(struct port *port);
124 static void ad_port_selection_logic(struct port *port, bool *update_slave_arr);
125 static void ad_agg_selection_logic(struct aggregator *aggregator,
126 bool *update_slave_arr);
127 static void ad_clear_agg(struct aggregator *aggregator);
128 static void ad_initialize_agg(struct aggregator *aggregator);
129 static void ad_initialize_port(struct port *port, int lacp_fast);
130 static void ad_enable_collecting_distributing(struct port *port,
131 bool *update_slave_arr);
132 static void ad_disable_collecting_distributing(struct port *port,
133 bool *update_slave_arr);
134 static void ad_marker_info_received(struct bond_marker *marker_info,
135 struct port *port);
136 static void ad_marker_response_received(struct bond_marker *marker,
137 struct port *port);
138 static void ad_update_actor_keys(struct port *port, bool reset);
141 /* ================= api to bonding and kernel code ================== */
144 * __get_bond_by_port - get the port's bonding struct
145 * @port: the port we're looking at
147 * Return @port's bonding struct, or %NULL if it can't be found.
149 static inline struct bonding *__get_bond_by_port(struct port *port)
151 if (port->slave == NULL)
152 return NULL;
154 return bond_get_bond_by_slave(port->slave);
158 * __get_first_agg - get the first aggregator in the bond
159 * @bond: the bond we're looking at
161 * Return the aggregator of the first slave in @bond, or %NULL if it can't be
162 * found.
163 * The caller must hold RCU or RTNL lock.
165 static inline struct aggregator *__get_first_agg(struct port *port)
167 struct bonding *bond = __get_bond_by_port(port);
168 struct slave *first_slave;
169 struct aggregator *agg;
171 /* If there's no bond for this port, or bond has no slaves */
172 if (bond == NULL)
173 return NULL;
175 rcu_read_lock();
176 first_slave = bond_first_slave_rcu(bond);
177 agg = first_slave ? &(SLAVE_AD_INFO(first_slave)->aggregator) : NULL;
178 rcu_read_unlock();
180 return agg;
184 * __agg_has_partner - see if we have a partner
185 * @agg: the agregator we're looking at
187 * Return nonzero if aggregator has a partner (denoted by a non-zero ether
188 * address for the partner). Return 0 if not.
190 static inline int __agg_has_partner(struct aggregator *agg)
192 return !is_zero_ether_addr(agg->partner_system.mac_addr_value);
196 * __disable_port - disable the port's slave
197 * @port: the port we're looking at
199 static inline void __disable_port(struct port *port)
201 bond_set_slave_inactive_flags(port->slave, BOND_SLAVE_NOTIFY_LATER);
205 * __enable_port - enable the port's slave, if it's up
206 * @port: the port we're looking at
208 static inline void __enable_port(struct port *port)
210 struct slave *slave = port->slave;
212 if ((slave->link == BOND_LINK_UP) && bond_slave_is_up(slave))
213 bond_set_slave_active_flags(slave, BOND_SLAVE_NOTIFY_LATER);
217 * __port_is_enabled - check if the port's slave is in active state
218 * @port: the port we're looking at
220 static inline int __port_is_enabled(struct port *port)
222 return bond_is_active_slave(port->slave);
226 * __get_agg_selection_mode - get the aggregator selection mode
227 * @port: the port we're looking at
229 * Get the aggregator selection mode. Can be %STABLE, %BANDWIDTH or %COUNT.
231 static inline u32 __get_agg_selection_mode(struct port *port)
233 struct bonding *bond = __get_bond_by_port(port);
235 if (bond == NULL)
236 return BOND_AD_STABLE;
238 return bond->params.ad_select;
242 * __check_agg_selection_timer - check if the selection timer has expired
243 * @port: the port we're looking at
245 static inline int __check_agg_selection_timer(struct port *port)
247 struct bonding *bond = __get_bond_by_port(port);
249 if (bond == NULL)
250 return 0;
252 return BOND_AD_INFO(bond).agg_select_timer ? 1 : 0;
256 * __get_link_speed - get a port's speed
257 * @port: the port we're looking at
259 * Return @port's speed in 802.3ad enum format. i.e. one of:
260 * 0,
261 * %AD_LINK_SPEED_10MBPS,
262 * %AD_LINK_SPEED_100MBPS,
263 * %AD_LINK_SPEED_1000MBPS,
264 * %AD_LINK_SPEED_2500MBPS,
265 * %AD_LINK_SPEED_5000MBPS,
266 * %AD_LINK_SPEED_10000MBPS
267 * %AD_LINK_SPEED_14000MBPS,
268 * %AD_LINK_SPEED_20000MBPS
269 * %AD_LINK_SPEED_25000MBPS
270 * %AD_LINK_SPEED_40000MBPS
271 * %AD_LINK_SPEED_50000MBPS
272 * %AD_LINK_SPEED_56000MBPS
273 * %AD_LINK_SPEED_100000MBPS
275 static u16 __get_link_speed(struct port *port)
277 struct slave *slave = port->slave;
278 u16 speed;
280 /* this if covers only a special case: when the configuration starts
281 * with link down, it sets the speed to 0.
282 * This is done in spite of the fact that the e100 driver reports 0
283 * to be compatible with MVT in the future.
285 if (slave->link != BOND_LINK_UP)
286 speed = 0;
287 else {
288 switch (slave->speed) {
289 case SPEED_10:
290 speed = AD_LINK_SPEED_10MBPS;
291 break;
293 case SPEED_100:
294 speed = AD_LINK_SPEED_100MBPS;
295 break;
297 case SPEED_1000:
298 speed = AD_LINK_SPEED_1000MBPS;
299 break;
301 case SPEED_2500:
302 speed = AD_LINK_SPEED_2500MBPS;
303 break;
305 case SPEED_5000:
306 speed = AD_LINK_SPEED_5000MBPS;
307 break;
309 case SPEED_10000:
310 speed = AD_LINK_SPEED_10000MBPS;
311 break;
313 case SPEED_14000:
314 speed = AD_LINK_SPEED_14000MBPS;
315 break;
317 case SPEED_20000:
318 speed = AD_LINK_SPEED_20000MBPS;
319 break;
321 case SPEED_25000:
322 speed = AD_LINK_SPEED_25000MBPS;
323 break;
325 case SPEED_40000:
326 speed = AD_LINK_SPEED_40000MBPS;
327 break;
329 case SPEED_50000:
330 speed = AD_LINK_SPEED_50000MBPS;
331 break;
333 case SPEED_56000:
334 speed = AD_LINK_SPEED_56000MBPS;
335 break;
337 case SPEED_100000:
338 speed = AD_LINK_SPEED_100000MBPS;
339 break;
341 default:
342 /* unknown speed value from ethtool. shouldn't happen */
343 if (slave->speed != SPEED_UNKNOWN)
344 pr_warn_once("%s: unknown ethtool speed (%d) for port %d (set it to 0)\n",
345 slave->bond->dev->name,
346 slave->speed,
347 port->actor_port_number);
348 speed = 0;
349 break;
353 netdev_dbg(slave->bond->dev, "Port %d Received link speed %d update from adapter\n",
354 port->actor_port_number, speed);
355 return speed;
359 * __get_duplex - get a port's duplex
360 * @port: the port we're looking at
362 * Return @port's duplex in 802.3ad bitmask format. i.e.:
363 * 0x01 if in full duplex
364 * 0x00 otherwise
366 static u8 __get_duplex(struct port *port)
368 struct slave *slave = port->slave;
369 u8 retval = 0x0;
371 /* handling a special case: when the configuration starts with
372 * link down, it sets the duplex to 0.
374 if (slave->link == BOND_LINK_UP) {
375 switch (slave->duplex) {
376 case DUPLEX_FULL:
377 retval = 0x1;
378 netdev_dbg(slave->bond->dev, "Port %d Received status full duplex update from adapter\n",
379 port->actor_port_number);
380 break;
381 case DUPLEX_HALF:
382 default:
383 retval = 0x0;
384 netdev_dbg(slave->bond->dev, "Port %d Received status NOT full duplex update from adapter\n",
385 port->actor_port_number);
386 break;
389 return retval;
392 static void __ad_actor_update_port(struct port *port)
394 const struct bonding *bond = bond_get_bond_by_slave(port->slave);
396 port->actor_system = BOND_AD_INFO(bond).system.sys_mac_addr;
397 port->actor_system_priority = BOND_AD_INFO(bond).system.sys_priority;
400 /* Conversions */
403 * __ad_timer_to_ticks - convert a given timer type to AD module ticks
404 * @timer_type: which timer to operate
405 * @par: timer parameter. see below
407 * If @timer_type is %current_while_timer, @par indicates long/short timer.
408 * If @timer_type is %periodic_timer, @par is one of %FAST_PERIODIC_TIME,
409 * %SLOW_PERIODIC_TIME.
411 static u16 __ad_timer_to_ticks(u16 timer_type, u16 par)
413 u16 retval = 0; /* to silence the compiler */
415 switch (timer_type) {
416 case AD_CURRENT_WHILE_TIMER: /* for rx machine usage */
417 if (par)
418 retval = (AD_SHORT_TIMEOUT_TIME*ad_ticks_per_sec);
419 else
420 retval = (AD_LONG_TIMEOUT_TIME*ad_ticks_per_sec);
421 break;
422 case AD_ACTOR_CHURN_TIMER: /* for local churn machine */
423 retval = (AD_CHURN_DETECTION_TIME*ad_ticks_per_sec);
424 break;
425 case AD_PERIODIC_TIMER: /* for periodic machine */
426 retval = (par*ad_ticks_per_sec); /* long timeout */
427 break;
428 case AD_PARTNER_CHURN_TIMER: /* for remote churn machine */
429 retval = (AD_CHURN_DETECTION_TIME*ad_ticks_per_sec);
430 break;
431 case AD_WAIT_WHILE_TIMER: /* for selection machine */
432 retval = (AD_AGGREGATE_WAIT_TIME*ad_ticks_per_sec);
433 break;
436 return retval;
440 /* ================= ad_rx_machine helper functions ================== */
443 * __choose_matched - update a port's matched variable from a received lacpdu
444 * @lacpdu: the lacpdu we've received
445 * @port: the port we're looking at
447 * Update the value of the matched variable, using parameter values from a
448 * newly received lacpdu. Parameter values for the partner carried in the
449 * received PDU are compared with the corresponding operational parameter
450 * values for the actor. Matched is set to TRUE if all of these parameters
451 * match and the PDU parameter partner_state.aggregation has the same value as
452 * actor_oper_port_state.aggregation and lacp will actively maintain the link
453 * in the aggregation. Matched is also set to TRUE if the value of
454 * actor_state.aggregation in the received PDU is set to FALSE, i.e., indicates
455 * an individual link and lacp will actively maintain the link. Otherwise,
456 * matched is set to FALSE. LACP is considered to be actively maintaining the
457 * link if either the PDU's actor_state.lacp_activity variable is TRUE or both
458 * the actor's actor_oper_port_state.lacp_activity and the PDU's
459 * partner_state.lacp_activity variables are TRUE.
461 * Note: the AD_PORT_MATCHED "variable" is not specified by 802.3ad; it is
462 * used here to implement the language from 802.3ad 43.4.9 that requires
463 * recordPDU to "match" the LACPDU parameters to the stored values.
465 static void __choose_matched(struct lacpdu *lacpdu, struct port *port)
467 /* check if all parameters are alike
468 * or this is individual link(aggregation == FALSE)
469 * then update the state machine Matched variable.
471 if (((ntohs(lacpdu->partner_port) == port->actor_port_number) &&
472 (ntohs(lacpdu->partner_port_priority) == port->actor_port_priority) &&
473 MAC_ADDRESS_EQUAL(&(lacpdu->partner_system), &(port->actor_system)) &&
474 (ntohs(lacpdu->partner_system_priority) == port->actor_system_priority) &&
475 (ntohs(lacpdu->partner_key) == port->actor_oper_port_key) &&
476 ((lacpdu->partner_state & AD_STATE_AGGREGATION) == (port->actor_oper_port_state & AD_STATE_AGGREGATION))) ||
477 ((lacpdu->actor_state & AD_STATE_AGGREGATION) == 0)
479 port->sm_vars |= AD_PORT_MATCHED;
480 } else {
481 port->sm_vars &= ~AD_PORT_MATCHED;
486 * __record_pdu - record parameters from a received lacpdu
487 * @lacpdu: the lacpdu we've received
488 * @port: the port we're looking at
490 * Record the parameter values for the Actor carried in a received lacpdu as
491 * the current partner operational parameter values and sets
492 * actor_oper_port_state.defaulted to FALSE.
494 static void __record_pdu(struct lacpdu *lacpdu, struct port *port)
496 if (lacpdu && port) {
497 struct port_params *partner = &port->partner_oper;
499 __choose_matched(lacpdu, port);
500 /* record the new parameter values for the partner
501 * operational
503 partner->port_number = ntohs(lacpdu->actor_port);
504 partner->port_priority = ntohs(lacpdu->actor_port_priority);
505 partner->system = lacpdu->actor_system;
506 partner->system_priority = ntohs(lacpdu->actor_system_priority);
507 partner->key = ntohs(lacpdu->actor_key);
508 partner->port_state = lacpdu->actor_state;
510 /* set actor_oper_port_state.defaulted to FALSE */
511 port->actor_oper_port_state &= ~AD_STATE_DEFAULTED;
513 /* set the partner sync. to on if the partner is sync,
514 * and the port is matched
516 if ((port->sm_vars & AD_PORT_MATCHED) &&
517 (lacpdu->actor_state & AD_STATE_SYNCHRONIZATION)) {
518 partner->port_state |= AD_STATE_SYNCHRONIZATION;
519 pr_debug("%s partner sync=1\n", port->slave->dev->name);
520 } else {
521 partner->port_state &= ~AD_STATE_SYNCHRONIZATION;
522 pr_debug("%s partner sync=0\n", port->slave->dev->name);
528 * __record_default - record default parameters
529 * @port: the port we're looking at
531 * This function records the default parameter values for the partner carried
532 * in the Partner Admin parameters as the current partner operational parameter
533 * values and sets actor_oper_port_state.defaulted to TRUE.
535 static void __record_default(struct port *port)
537 if (port) {
538 /* record the partner admin parameters */
539 memcpy(&port->partner_oper, &port->partner_admin,
540 sizeof(struct port_params));
542 /* set actor_oper_port_state.defaulted to true */
543 port->actor_oper_port_state |= AD_STATE_DEFAULTED;
548 * __update_selected - update a port's Selected variable from a received lacpdu
549 * @lacpdu: the lacpdu we've received
550 * @port: the port we're looking at
552 * Update the value of the selected variable, using parameter values from a
553 * newly received lacpdu. The parameter values for the Actor carried in the
554 * received PDU are compared with the corresponding operational parameter
555 * values for the ports partner. If one or more of the comparisons shows that
556 * the value(s) received in the PDU differ from the current operational values,
557 * then selected is set to FALSE and actor_oper_port_state.synchronization is
558 * set to out_of_sync. Otherwise, selected remains unchanged.
560 static void __update_selected(struct lacpdu *lacpdu, struct port *port)
562 if (lacpdu && port) {
563 const struct port_params *partner = &port->partner_oper;
565 /* check if any parameter is different then
566 * update the state machine selected variable.
568 if (ntohs(lacpdu->actor_port) != partner->port_number ||
569 ntohs(lacpdu->actor_port_priority) != partner->port_priority ||
570 !MAC_ADDRESS_EQUAL(&lacpdu->actor_system, &partner->system) ||
571 ntohs(lacpdu->actor_system_priority) != partner->system_priority ||
572 ntohs(lacpdu->actor_key) != partner->key ||
573 (lacpdu->actor_state & AD_STATE_AGGREGATION) != (partner->port_state & AD_STATE_AGGREGATION)) {
574 port->sm_vars &= ~AD_PORT_SELECTED;
580 * __update_default_selected - update a port's Selected variable from Partner
581 * @port: the port we're looking at
583 * This function updates the value of the selected variable, using the partner
584 * administrative parameter values. The administrative values are compared with
585 * the corresponding operational parameter values for the partner. If one or
586 * more of the comparisons shows that the administrative value(s) differ from
587 * the current operational values, then Selected is set to FALSE and
588 * actor_oper_port_state.synchronization is set to OUT_OF_SYNC. Otherwise,
589 * Selected remains unchanged.
591 static void __update_default_selected(struct port *port)
593 if (port) {
594 const struct port_params *admin = &port->partner_admin;
595 const struct port_params *oper = &port->partner_oper;
597 /* check if any parameter is different then
598 * update the state machine selected variable.
600 if (admin->port_number != oper->port_number ||
601 admin->port_priority != oper->port_priority ||
602 !MAC_ADDRESS_EQUAL(&admin->system, &oper->system) ||
603 admin->system_priority != oper->system_priority ||
604 admin->key != oper->key ||
605 (admin->port_state & AD_STATE_AGGREGATION)
606 != (oper->port_state & AD_STATE_AGGREGATION)) {
607 port->sm_vars &= ~AD_PORT_SELECTED;
613 * __update_ntt - update a port's ntt variable from a received lacpdu
614 * @lacpdu: the lacpdu we've received
615 * @port: the port we're looking at
617 * Updates the value of the ntt variable, using parameter values from a newly
618 * received lacpdu. The parameter values for the partner carried in the
619 * received PDU are compared with the corresponding operational parameter
620 * values for the Actor. If one or more of the comparisons shows that the
621 * value(s) received in the PDU differ from the current operational values,
622 * then ntt is set to TRUE. Otherwise, ntt remains unchanged.
624 static void __update_ntt(struct lacpdu *lacpdu, struct port *port)
626 /* validate lacpdu and port */
627 if (lacpdu && port) {
628 /* check if any parameter is different then
629 * update the port->ntt.
631 if ((ntohs(lacpdu->partner_port) != port->actor_port_number) ||
632 (ntohs(lacpdu->partner_port_priority) != port->actor_port_priority) ||
633 !MAC_ADDRESS_EQUAL(&(lacpdu->partner_system), &(port->actor_system)) ||
634 (ntohs(lacpdu->partner_system_priority) != port->actor_system_priority) ||
635 (ntohs(lacpdu->partner_key) != port->actor_oper_port_key) ||
636 ((lacpdu->partner_state & AD_STATE_LACP_ACTIVITY) != (port->actor_oper_port_state & AD_STATE_LACP_ACTIVITY)) ||
637 ((lacpdu->partner_state & AD_STATE_LACP_TIMEOUT) != (port->actor_oper_port_state & AD_STATE_LACP_TIMEOUT)) ||
638 ((lacpdu->partner_state & AD_STATE_SYNCHRONIZATION) != (port->actor_oper_port_state & AD_STATE_SYNCHRONIZATION)) ||
639 ((lacpdu->partner_state & AD_STATE_AGGREGATION) != (port->actor_oper_port_state & AD_STATE_AGGREGATION))
641 port->ntt = true;
647 * __agg_ports_are_ready - check if all ports in an aggregator are ready
648 * @aggregator: the aggregator we're looking at
651 static int __agg_ports_are_ready(struct aggregator *aggregator)
653 struct port *port;
654 int retval = 1;
656 if (aggregator) {
657 /* scan all ports in this aggregator to verfy if they are
658 * all ready.
660 for (port = aggregator->lag_ports;
661 port;
662 port = port->next_port_in_aggregator) {
663 if (!(port->sm_vars & AD_PORT_READY_N)) {
664 retval = 0;
665 break;
670 return retval;
674 * __set_agg_ports_ready - set value of Ready bit in all ports of an aggregator
675 * @aggregator: the aggregator we're looking at
676 * @val: Should the ports' ready bit be set on or off
679 static void __set_agg_ports_ready(struct aggregator *aggregator, int val)
681 struct port *port;
683 for (port = aggregator->lag_ports; port;
684 port = port->next_port_in_aggregator) {
685 if (val)
686 port->sm_vars |= AD_PORT_READY;
687 else
688 port->sm_vars &= ~AD_PORT_READY;
692 static int __agg_active_ports(struct aggregator *agg)
694 struct port *port;
695 int active = 0;
697 for (port = agg->lag_ports; port;
698 port = port->next_port_in_aggregator) {
699 if (port->is_enabled)
700 active++;
703 return active;
707 * __get_agg_bandwidth - get the total bandwidth of an aggregator
708 * @aggregator: the aggregator we're looking at
711 static u32 __get_agg_bandwidth(struct aggregator *aggregator)
713 int nports = __agg_active_ports(aggregator);
714 u32 bandwidth = 0;
716 if (nports) {
717 switch (__get_link_speed(aggregator->lag_ports)) {
718 case AD_LINK_SPEED_1MBPS:
719 bandwidth = nports;
720 break;
721 case AD_LINK_SPEED_10MBPS:
722 bandwidth = nports * 10;
723 break;
724 case AD_LINK_SPEED_100MBPS:
725 bandwidth = nports * 100;
726 break;
727 case AD_LINK_SPEED_1000MBPS:
728 bandwidth = nports * 1000;
729 break;
730 case AD_LINK_SPEED_2500MBPS:
731 bandwidth = nports * 2500;
732 break;
733 case AD_LINK_SPEED_5000MBPS:
734 bandwidth = nports * 5000;
735 break;
736 case AD_LINK_SPEED_10000MBPS:
737 bandwidth = nports * 10000;
738 break;
739 case AD_LINK_SPEED_14000MBPS:
740 bandwidth = nports * 14000;
741 break;
742 case AD_LINK_SPEED_20000MBPS:
743 bandwidth = nports * 20000;
744 break;
745 case AD_LINK_SPEED_25000MBPS:
746 bandwidth = nports * 25000;
747 break;
748 case AD_LINK_SPEED_40000MBPS:
749 bandwidth = nports * 40000;
750 break;
751 case AD_LINK_SPEED_50000MBPS:
752 bandwidth = nports * 50000;
753 break;
754 case AD_LINK_SPEED_56000MBPS:
755 bandwidth = nports * 56000;
756 break;
757 case AD_LINK_SPEED_100000MBPS:
758 bandwidth = nports * 100000;
759 break;
760 default:
761 bandwidth = 0; /* to silence the compiler */
764 return bandwidth;
768 * __get_active_agg - get the current active aggregator
769 * @aggregator: the aggregator we're looking at
771 * Caller must hold RCU lock.
773 static struct aggregator *__get_active_agg(struct aggregator *aggregator)
775 struct bonding *bond = aggregator->slave->bond;
776 struct list_head *iter;
777 struct slave *slave;
779 bond_for_each_slave_rcu(bond, slave, iter)
780 if (SLAVE_AD_INFO(slave)->aggregator.is_active)
781 return &(SLAVE_AD_INFO(slave)->aggregator);
783 return NULL;
787 * __update_lacpdu_from_port - update a port's lacpdu fields
788 * @port: the port we're looking at
790 static inline void __update_lacpdu_from_port(struct port *port)
792 struct lacpdu *lacpdu = &port->lacpdu;
793 const struct port_params *partner = &port->partner_oper;
795 /* update current actual Actor parameters
796 * lacpdu->subtype initialized
797 * lacpdu->version_number initialized
798 * lacpdu->tlv_type_actor_info initialized
799 * lacpdu->actor_information_length initialized
802 lacpdu->actor_system_priority = htons(port->actor_system_priority);
803 lacpdu->actor_system = port->actor_system;
804 lacpdu->actor_key = htons(port->actor_oper_port_key);
805 lacpdu->actor_port_priority = htons(port->actor_port_priority);
806 lacpdu->actor_port = htons(port->actor_port_number);
807 lacpdu->actor_state = port->actor_oper_port_state;
808 pr_debug("update lacpdu: %s, actor port state %x\n",
809 port->slave->dev->name, port->actor_oper_port_state);
811 /* lacpdu->reserved_3_1 initialized
812 * lacpdu->tlv_type_partner_info initialized
813 * lacpdu->partner_information_length initialized
816 lacpdu->partner_system_priority = htons(partner->system_priority);
817 lacpdu->partner_system = partner->system;
818 lacpdu->partner_key = htons(partner->key);
819 lacpdu->partner_port_priority = htons(partner->port_priority);
820 lacpdu->partner_port = htons(partner->port_number);
821 lacpdu->partner_state = partner->port_state;
823 /* lacpdu->reserved_3_2 initialized
824 * lacpdu->tlv_type_collector_info initialized
825 * lacpdu->collector_information_length initialized
826 * collector_max_delay initialized
827 * reserved_12[12] initialized
828 * tlv_type_terminator initialized
829 * terminator_length initialized
830 * reserved_50[50] initialized
834 /* ================= main 802.3ad protocol code ========================= */
837 * ad_lacpdu_send - send out a lacpdu packet on a given port
838 * @port: the port we're looking at
840 * Returns: 0 on success
841 * < 0 on error
843 static int ad_lacpdu_send(struct port *port)
845 struct slave *slave = port->slave;
846 struct sk_buff *skb;
847 struct lacpdu_header *lacpdu_header;
848 int length = sizeof(struct lacpdu_header);
850 skb = dev_alloc_skb(length);
851 if (!skb)
852 return -ENOMEM;
854 skb->dev = slave->dev;
855 skb_reset_mac_header(skb);
856 skb->network_header = skb->mac_header + ETH_HLEN;
857 skb->protocol = PKT_TYPE_LACPDU;
858 skb->priority = TC_PRIO_CONTROL;
860 lacpdu_header = skb_put(skb, length);
862 ether_addr_copy(lacpdu_header->hdr.h_dest, lacpdu_mcast_addr);
863 /* Note: source address is set to be the member's PERMANENT address,
864 * because we use it to identify loopback lacpdus in receive.
866 ether_addr_copy(lacpdu_header->hdr.h_source, slave->perm_hwaddr);
867 lacpdu_header->hdr.h_proto = PKT_TYPE_LACPDU;
869 lacpdu_header->lacpdu = port->lacpdu;
871 dev_queue_xmit(skb);
873 return 0;
877 * ad_marker_send - send marker information/response on a given port
878 * @port: the port we're looking at
879 * @marker: marker data to send
881 * Returns: 0 on success
882 * < 0 on error
884 static int ad_marker_send(struct port *port, struct bond_marker *marker)
886 struct slave *slave = port->slave;
887 struct sk_buff *skb;
888 struct bond_marker_header *marker_header;
889 int length = sizeof(struct bond_marker_header);
891 skb = dev_alloc_skb(length + 16);
892 if (!skb)
893 return -ENOMEM;
895 skb_reserve(skb, 16);
897 skb->dev = slave->dev;
898 skb_reset_mac_header(skb);
899 skb->network_header = skb->mac_header + ETH_HLEN;
900 skb->protocol = PKT_TYPE_LACPDU;
902 marker_header = skb_put(skb, length);
904 ether_addr_copy(marker_header->hdr.h_dest, lacpdu_mcast_addr);
905 /* Note: source address is set to be the member's PERMANENT address,
906 * because we use it to identify loopback MARKERs in receive.
908 ether_addr_copy(marker_header->hdr.h_source, slave->perm_hwaddr);
909 marker_header->hdr.h_proto = PKT_TYPE_LACPDU;
911 marker_header->marker = *marker;
913 dev_queue_xmit(skb);
915 return 0;
919 * ad_mux_machine - handle a port's mux state machine
920 * @port: the port we're looking at
921 * @update_slave_arr: Does slave array need update?
923 static void ad_mux_machine(struct port *port, bool *update_slave_arr)
925 mux_states_t last_state;
927 /* keep current State Machine state to compare later if it was
928 * changed
930 last_state = port->sm_mux_state;
932 if (port->sm_vars & AD_PORT_BEGIN) {
933 port->sm_mux_state = AD_MUX_DETACHED;
934 } else {
935 switch (port->sm_mux_state) {
936 case AD_MUX_DETACHED:
937 if ((port->sm_vars & AD_PORT_SELECTED)
938 || (port->sm_vars & AD_PORT_STANDBY))
939 /* if SELECTED or STANDBY */
940 port->sm_mux_state = AD_MUX_WAITING;
941 break;
942 case AD_MUX_WAITING:
943 /* if SELECTED == FALSE return to DETACH state */
944 if (!(port->sm_vars & AD_PORT_SELECTED)) {
945 port->sm_vars &= ~AD_PORT_READY_N;
946 /* in order to withhold the Selection Logic to
947 * check all ports READY_N value every callback
948 * cycle to update ready variable, we check
949 * READY_N and update READY here
951 __set_agg_ports_ready(port->aggregator, __agg_ports_are_ready(port->aggregator));
952 port->sm_mux_state = AD_MUX_DETACHED;
953 break;
956 /* check if the wait_while_timer expired */
957 if (port->sm_mux_timer_counter
958 && !(--port->sm_mux_timer_counter))
959 port->sm_vars |= AD_PORT_READY_N;
961 /* in order to withhold the selection logic to check
962 * all ports READY_N value every callback cycle to
963 * update ready variable, we check READY_N and update
964 * READY here
966 __set_agg_ports_ready(port->aggregator, __agg_ports_are_ready(port->aggregator));
968 /* if the wait_while_timer expired, and the port is
969 * in READY state, move to ATTACHED state
971 if ((port->sm_vars & AD_PORT_READY)
972 && !port->sm_mux_timer_counter)
973 port->sm_mux_state = AD_MUX_ATTACHED;
974 break;
975 case AD_MUX_ATTACHED:
976 /* check also if agg_select_timer expired (so the
977 * edable port will take place only after this timer)
979 if ((port->sm_vars & AD_PORT_SELECTED) &&
980 (port->partner_oper.port_state & AD_STATE_SYNCHRONIZATION) &&
981 !__check_agg_selection_timer(port)) {
982 if (port->aggregator->is_active)
983 port->sm_mux_state =
984 AD_MUX_COLLECTING_DISTRIBUTING;
985 } else if (!(port->sm_vars & AD_PORT_SELECTED) ||
986 (port->sm_vars & AD_PORT_STANDBY)) {
987 /* if UNSELECTED or STANDBY */
988 port->sm_vars &= ~AD_PORT_READY_N;
989 /* in order to withhold the selection logic to
990 * check all ports READY_N value every callback
991 * cycle to update ready variable, we check
992 * READY_N and update READY here
994 __set_agg_ports_ready(port->aggregator, __agg_ports_are_ready(port->aggregator));
995 port->sm_mux_state = AD_MUX_DETACHED;
996 } else if (port->aggregator->is_active) {
997 port->actor_oper_port_state |=
998 AD_STATE_SYNCHRONIZATION;
1000 break;
1001 case AD_MUX_COLLECTING_DISTRIBUTING:
1002 if (!(port->sm_vars & AD_PORT_SELECTED) ||
1003 (port->sm_vars & AD_PORT_STANDBY) ||
1004 !(port->partner_oper.port_state & AD_STATE_SYNCHRONIZATION) ||
1005 !(port->actor_oper_port_state & AD_STATE_SYNCHRONIZATION)) {
1006 port->sm_mux_state = AD_MUX_ATTACHED;
1007 } else {
1008 /* if port state hasn't changed make
1009 * sure that a collecting distributing
1010 * port in an active aggregator is enabled
1012 if (port->aggregator &&
1013 port->aggregator->is_active &&
1014 !__port_is_enabled(port)) {
1016 __enable_port(port);
1019 break;
1020 default:
1021 break;
1025 /* check if the state machine was changed */
1026 if (port->sm_mux_state != last_state) {
1027 pr_debug("Mux Machine: Port=%d (%s), Last State=%d, Curr State=%d\n",
1028 port->actor_port_number,
1029 port->slave->dev->name,
1030 last_state,
1031 port->sm_mux_state);
1032 switch (port->sm_mux_state) {
1033 case AD_MUX_DETACHED:
1034 port->actor_oper_port_state &= ~AD_STATE_SYNCHRONIZATION;
1035 ad_disable_collecting_distributing(port,
1036 update_slave_arr);
1037 port->actor_oper_port_state &= ~AD_STATE_COLLECTING;
1038 port->actor_oper_port_state &= ~AD_STATE_DISTRIBUTING;
1039 port->ntt = true;
1040 break;
1041 case AD_MUX_WAITING:
1042 port->sm_mux_timer_counter = __ad_timer_to_ticks(AD_WAIT_WHILE_TIMER, 0);
1043 break;
1044 case AD_MUX_ATTACHED:
1045 if (port->aggregator->is_active)
1046 port->actor_oper_port_state |=
1047 AD_STATE_SYNCHRONIZATION;
1048 else
1049 port->actor_oper_port_state &=
1050 ~AD_STATE_SYNCHRONIZATION;
1051 port->actor_oper_port_state &= ~AD_STATE_COLLECTING;
1052 port->actor_oper_port_state &= ~AD_STATE_DISTRIBUTING;
1053 ad_disable_collecting_distributing(port,
1054 update_slave_arr);
1055 port->ntt = true;
1056 break;
1057 case AD_MUX_COLLECTING_DISTRIBUTING:
1058 port->actor_oper_port_state |= AD_STATE_COLLECTING;
1059 port->actor_oper_port_state |= AD_STATE_DISTRIBUTING;
1060 port->actor_oper_port_state |= AD_STATE_SYNCHRONIZATION;
1061 ad_enable_collecting_distributing(port,
1062 update_slave_arr);
1063 port->ntt = true;
1064 break;
1065 default:
1066 break;
1072 * ad_rx_machine - handle a port's rx State Machine
1073 * @lacpdu: the lacpdu we've received
1074 * @port: the port we're looking at
1076 * If lacpdu arrived, stop previous timer (if exists) and set the next state as
1077 * CURRENT. If timer expired set the state machine in the proper state.
1078 * In other cases, this function checks if we need to switch to other state.
1080 static void ad_rx_machine(struct lacpdu *lacpdu, struct port *port)
1082 rx_states_t last_state;
1084 /* keep current State Machine state to compare later if it was
1085 * changed
1087 last_state = port->sm_rx_state;
1089 /* check if state machine should change state */
1091 /* first, check if port was reinitialized */
1092 if (port->sm_vars & AD_PORT_BEGIN) {
1093 port->sm_rx_state = AD_RX_INITIALIZE;
1094 port->sm_vars |= AD_PORT_CHURNED;
1095 /* check if port is not enabled */
1096 } else if (!(port->sm_vars & AD_PORT_BEGIN) && !port->is_enabled)
1097 port->sm_rx_state = AD_RX_PORT_DISABLED;
1098 /* check if new lacpdu arrived */
1099 else if (lacpdu && ((port->sm_rx_state == AD_RX_EXPIRED) ||
1100 (port->sm_rx_state == AD_RX_DEFAULTED) ||
1101 (port->sm_rx_state == AD_RX_CURRENT))) {
1102 if (port->sm_rx_state != AD_RX_CURRENT)
1103 port->sm_vars |= AD_PORT_CHURNED;
1104 port->sm_rx_timer_counter = 0;
1105 port->sm_rx_state = AD_RX_CURRENT;
1106 } else {
1107 /* if timer is on, and if it is expired */
1108 if (port->sm_rx_timer_counter &&
1109 !(--port->sm_rx_timer_counter)) {
1110 switch (port->sm_rx_state) {
1111 case AD_RX_EXPIRED:
1112 port->sm_rx_state = AD_RX_DEFAULTED;
1113 break;
1114 case AD_RX_CURRENT:
1115 port->sm_rx_state = AD_RX_EXPIRED;
1116 break;
1117 default:
1118 break;
1120 } else {
1121 /* if no lacpdu arrived and no timer is on */
1122 switch (port->sm_rx_state) {
1123 case AD_RX_PORT_DISABLED:
1124 if (port->is_enabled &&
1125 (port->sm_vars & AD_PORT_LACP_ENABLED))
1126 port->sm_rx_state = AD_RX_EXPIRED;
1127 else if (port->is_enabled
1128 && ((port->sm_vars
1129 & AD_PORT_LACP_ENABLED) == 0))
1130 port->sm_rx_state = AD_RX_LACP_DISABLED;
1131 break;
1132 default:
1133 break;
1139 /* check if the State machine was changed or new lacpdu arrived */
1140 if ((port->sm_rx_state != last_state) || (lacpdu)) {
1141 pr_debug("Rx Machine: Port=%d (%s), Last State=%d, Curr State=%d\n",
1142 port->actor_port_number,
1143 port->slave->dev->name,
1144 last_state,
1145 port->sm_rx_state);
1146 switch (port->sm_rx_state) {
1147 case AD_RX_INITIALIZE:
1148 if (!(port->actor_oper_port_key & AD_DUPLEX_KEY_MASKS))
1149 port->sm_vars &= ~AD_PORT_LACP_ENABLED;
1150 else
1151 port->sm_vars |= AD_PORT_LACP_ENABLED;
1152 port->sm_vars &= ~AD_PORT_SELECTED;
1153 __record_default(port);
1154 port->actor_oper_port_state &= ~AD_STATE_EXPIRED;
1155 port->sm_rx_state = AD_RX_PORT_DISABLED;
1157 /* Fall Through */
1158 case AD_RX_PORT_DISABLED:
1159 port->sm_vars &= ~AD_PORT_MATCHED;
1160 break;
1161 case AD_RX_LACP_DISABLED:
1162 port->sm_vars &= ~AD_PORT_SELECTED;
1163 __record_default(port);
1164 port->partner_oper.port_state &= ~AD_STATE_AGGREGATION;
1165 port->sm_vars |= AD_PORT_MATCHED;
1166 port->actor_oper_port_state &= ~AD_STATE_EXPIRED;
1167 break;
1168 case AD_RX_EXPIRED:
1169 /* Reset of the Synchronization flag (Standard 43.4.12)
1170 * This reset cause to disable this port in the
1171 * COLLECTING_DISTRIBUTING state of the mux machine in
1172 * case of EXPIRED even if LINK_DOWN didn't arrive for
1173 * the port.
1175 port->partner_oper.port_state &= ~AD_STATE_SYNCHRONIZATION;
1176 port->sm_vars &= ~AD_PORT_MATCHED;
1177 port->partner_oper.port_state |= AD_STATE_LACP_TIMEOUT;
1178 port->partner_oper.port_state |= AD_STATE_LACP_ACTIVITY;
1179 port->sm_rx_timer_counter = __ad_timer_to_ticks(AD_CURRENT_WHILE_TIMER, (u16)(AD_SHORT_TIMEOUT));
1180 port->actor_oper_port_state |= AD_STATE_EXPIRED;
1181 port->sm_vars |= AD_PORT_CHURNED;
1182 break;
1183 case AD_RX_DEFAULTED:
1184 __update_default_selected(port);
1185 __record_default(port);
1186 port->sm_vars |= AD_PORT_MATCHED;
1187 port->actor_oper_port_state &= ~AD_STATE_EXPIRED;
1188 break;
1189 case AD_RX_CURRENT:
1190 /* detect loopback situation */
1191 if (MAC_ADDRESS_EQUAL(&(lacpdu->actor_system),
1192 &(port->actor_system))) {
1193 netdev_err(port->slave->bond->dev, "An illegal loopback occurred on adapter (%s)\n"
1194 "Check the configuration to verify that all adapters are connected to 802.3ad compliant switch ports\n",
1195 port->slave->dev->name);
1196 return;
1198 __update_selected(lacpdu, port);
1199 __update_ntt(lacpdu, port);
1200 __record_pdu(lacpdu, port);
1201 port->sm_rx_timer_counter = __ad_timer_to_ticks(AD_CURRENT_WHILE_TIMER, (u16)(port->actor_oper_port_state & AD_STATE_LACP_TIMEOUT));
1202 port->actor_oper_port_state &= ~AD_STATE_EXPIRED;
1203 break;
1204 default:
1205 break;
1211 * ad_churn_machine - handle port churn's state machine
1212 * @port: the port we're looking at
1215 static void ad_churn_machine(struct port *port)
1217 if (port->sm_vars & AD_PORT_CHURNED) {
1218 port->sm_vars &= ~AD_PORT_CHURNED;
1219 port->sm_churn_actor_state = AD_CHURN_MONITOR;
1220 port->sm_churn_partner_state = AD_CHURN_MONITOR;
1221 port->sm_churn_actor_timer_counter =
1222 __ad_timer_to_ticks(AD_ACTOR_CHURN_TIMER, 0);
1223 port->sm_churn_partner_timer_counter =
1224 __ad_timer_to_ticks(AD_PARTNER_CHURN_TIMER, 0);
1225 return;
1227 if (port->sm_churn_actor_timer_counter &&
1228 !(--port->sm_churn_actor_timer_counter) &&
1229 port->sm_churn_actor_state == AD_CHURN_MONITOR) {
1230 if (port->actor_oper_port_state & AD_STATE_SYNCHRONIZATION) {
1231 port->sm_churn_actor_state = AD_NO_CHURN;
1232 } else {
1233 port->churn_actor_count++;
1234 port->sm_churn_actor_state = AD_CHURN;
1237 if (port->sm_churn_partner_timer_counter &&
1238 !(--port->sm_churn_partner_timer_counter) &&
1239 port->sm_churn_partner_state == AD_CHURN_MONITOR) {
1240 if (port->partner_oper.port_state & AD_STATE_SYNCHRONIZATION) {
1241 port->sm_churn_partner_state = AD_NO_CHURN;
1242 } else {
1243 port->churn_partner_count++;
1244 port->sm_churn_partner_state = AD_CHURN;
1250 * ad_tx_machine - handle a port's tx state machine
1251 * @port: the port we're looking at
1253 static void ad_tx_machine(struct port *port)
1255 /* check if tx timer expired, to verify that we do not send more than
1256 * 3 packets per second
1258 if (port->sm_tx_timer_counter && !(--port->sm_tx_timer_counter)) {
1259 /* check if there is something to send */
1260 if (port->ntt && (port->sm_vars & AD_PORT_LACP_ENABLED)) {
1261 __update_lacpdu_from_port(port);
1263 if (ad_lacpdu_send(port) >= 0) {
1264 pr_debug("Sent LACPDU on port %d\n",
1265 port->actor_port_number);
1267 /* mark ntt as false, so it will not be sent
1268 * again until demanded
1270 port->ntt = false;
1273 /* restart tx timer(to verify that we will not exceed
1274 * AD_MAX_TX_IN_SECOND
1276 port->sm_tx_timer_counter = ad_ticks_per_sec/AD_MAX_TX_IN_SECOND;
1281 * ad_periodic_machine - handle a port's periodic state machine
1282 * @port: the port we're looking at
1284 * Turn ntt flag on priodically to perform periodic transmission of lacpdu's.
1286 static void ad_periodic_machine(struct port *port)
1288 periodic_states_t last_state;
1290 /* keep current state machine state to compare later if it was changed */
1291 last_state = port->sm_periodic_state;
1293 /* check if port was reinitialized */
1294 if (((port->sm_vars & AD_PORT_BEGIN) || !(port->sm_vars & AD_PORT_LACP_ENABLED) || !port->is_enabled) ||
1295 (!(port->actor_oper_port_state & AD_STATE_LACP_ACTIVITY) && !(port->partner_oper.port_state & AD_STATE_LACP_ACTIVITY))
1297 port->sm_periodic_state = AD_NO_PERIODIC;
1299 /* check if state machine should change state */
1300 else if (port->sm_periodic_timer_counter) {
1301 /* check if periodic state machine expired */
1302 if (!(--port->sm_periodic_timer_counter)) {
1303 /* if expired then do tx */
1304 port->sm_periodic_state = AD_PERIODIC_TX;
1305 } else {
1306 /* If not expired, check if there is some new timeout
1307 * parameter from the partner state
1309 switch (port->sm_periodic_state) {
1310 case AD_FAST_PERIODIC:
1311 if (!(port->partner_oper.port_state
1312 & AD_STATE_LACP_TIMEOUT))
1313 port->sm_periodic_state = AD_SLOW_PERIODIC;
1314 break;
1315 case AD_SLOW_PERIODIC:
1316 if ((port->partner_oper.port_state & AD_STATE_LACP_TIMEOUT)) {
1317 port->sm_periodic_timer_counter = 0;
1318 port->sm_periodic_state = AD_PERIODIC_TX;
1320 break;
1321 default:
1322 break;
1325 } else {
1326 switch (port->sm_periodic_state) {
1327 case AD_NO_PERIODIC:
1328 port->sm_periodic_state = AD_FAST_PERIODIC;
1329 break;
1330 case AD_PERIODIC_TX:
1331 if (!(port->partner_oper.port_state &
1332 AD_STATE_LACP_TIMEOUT))
1333 port->sm_periodic_state = AD_SLOW_PERIODIC;
1334 else
1335 port->sm_periodic_state = AD_FAST_PERIODIC;
1336 break;
1337 default:
1338 break;
1342 /* check if the state machine was changed */
1343 if (port->sm_periodic_state != last_state) {
1344 pr_debug("Periodic Machine: Port=%d, Last State=%d, Curr State=%d\n",
1345 port->actor_port_number, last_state,
1346 port->sm_periodic_state);
1347 switch (port->sm_periodic_state) {
1348 case AD_NO_PERIODIC:
1349 port->sm_periodic_timer_counter = 0;
1350 break;
1351 case AD_FAST_PERIODIC:
1352 /* decrement 1 tick we lost in the PERIODIC_TX cycle */
1353 port->sm_periodic_timer_counter = __ad_timer_to_ticks(AD_PERIODIC_TIMER, (u16)(AD_FAST_PERIODIC_TIME))-1;
1354 break;
1355 case AD_SLOW_PERIODIC:
1356 /* decrement 1 tick we lost in the PERIODIC_TX cycle */
1357 port->sm_periodic_timer_counter = __ad_timer_to_ticks(AD_PERIODIC_TIMER, (u16)(AD_SLOW_PERIODIC_TIME))-1;
1358 break;
1359 case AD_PERIODIC_TX:
1360 port->ntt = true;
1361 break;
1362 default:
1363 break;
1369 * ad_port_selection_logic - select aggregation groups
1370 * @port: the port we're looking at
1371 * @update_slave_arr: Does slave array need update?
1373 * Select aggregation groups, and assign each port for it's aggregetor. The
1374 * selection logic is called in the inititalization (after all the handshkes),
1375 * and after every lacpdu receive (if selected is off).
1377 static void ad_port_selection_logic(struct port *port, bool *update_slave_arr)
1379 struct aggregator *aggregator, *free_aggregator = NULL, *temp_aggregator;
1380 struct port *last_port = NULL, *curr_port;
1381 struct list_head *iter;
1382 struct bonding *bond;
1383 struct slave *slave;
1384 int found = 0;
1386 /* if the port is already Selected, do nothing */
1387 if (port->sm_vars & AD_PORT_SELECTED)
1388 return;
1390 bond = __get_bond_by_port(port);
1392 /* if the port is connected to other aggregator, detach it */
1393 if (port->aggregator) {
1394 /* detach the port from its former aggregator */
1395 temp_aggregator = port->aggregator;
1396 for (curr_port = temp_aggregator->lag_ports; curr_port;
1397 last_port = curr_port,
1398 curr_port = curr_port->next_port_in_aggregator) {
1399 if (curr_port == port) {
1400 temp_aggregator->num_of_ports--;
1401 /* if it is the first port attached to the
1402 * aggregator
1404 if (!last_port) {
1405 temp_aggregator->lag_ports =
1406 port->next_port_in_aggregator;
1407 } else {
1408 /* not the first port attached to the
1409 * aggregator
1411 last_port->next_port_in_aggregator =
1412 port->next_port_in_aggregator;
1415 /* clear the port's relations to this
1416 * aggregator
1418 port->aggregator = NULL;
1419 port->next_port_in_aggregator = NULL;
1420 port->actor_port_aggregator_identifier = 0;
1422 netdev_dbg(bond->dev, "Port %d left LAG %d\n",
1423 port->actor_port_number,
1424 temp_aggregator->aggregator_identifier);
1425 /* if the aggregator is empty, clear its
1426 * parameters, and set it ready to be attached
1428 if (!temp_aggregator->lag_ports)
1429 ad_clear_agg(temp_aggregator);
1430 break;
1433 if (!curr_port) {
1434 /* meaning: the port was related to an aggregator
1435 * but was not on the aggregator port list
1437 net_warn_ratelimited("%s: Warning: Port %d (on %s) was related to aggregator %d but was not on its port list\n",
1438 port->slave->bond->dev->name,
1439 port->actor_port_number,
1440 port->slave->dev->name,
1441 port->aggregator->aggregator_identifier);
1444 /* search on all aggregators for a suitable aggregator for this port */
1445 bond_for_each_slave(bond, slave, iter) {
1446 aggregator = &(SLAVE_AD_INFO(slave)->aggregator);
1448 /* keep a free aggregator for later use(if needed) */
1449 if (!aggregator->lag_ports) {
1450 if (!free_aggregator)
1451 free_aggregator = aggregator;
1452 continue;
1454 /* check if current aggregator suits us */
1455 if (((aggregator->actor_oper_aggregator_key == port->actor_oper_port_key) && /* if all parameters match AND */
1456 MAC_ADDRESS_EQUAL(&(aggregator->partner_system), &(port->partner_oper.system)) &&
1457 (aggregator->partner_system_priority == port->partner_oper.system_priority) &&
1458 (aggregator->partner_oper_aggregator_key == port->partner_oper.key)
1459 ) &&
1460 ((!MAC_ADDRESS_EQUAL(&(port->partner_oper.system), &(null_mac_addr)) && /* partner answers */
1461 !aggregator->is_individual) /* but is not individual OR */
1464 /* attach to the founded aggregator */
1465 port->aggregator = aggregator;
1466 port->actor_port_aggregator_identifier =
1467 port->aggregator->aggregator_identifier;
1468 port->next_port_in_aggregator = aggregator->lag_ports;
1469 port->aggregator->num_of_ports++;
1470 aggregator->lag_ports = port;
1471 netdev_dbg(bond->dev, "Port %d joined LAG %d(existing LAG)\n",
1472 port->actor_port_number,
1473 port->aggregator->aggregator_identifier);
1475 /* mark this port as selected */
1476 port->sm_vars |= AD_PORT_SELECTED;
1477 found = 1;
1478 break;
1482 /* the port couldn't find an aggregator - attach it to a new
1483 * aggregator
1485 if (!found) {
1486 if (free_aggregator) {
1487 /* assign port a new aggregator */
1488 port->aggregator = free_aggregator;
1489 port->actor_port_aggregator_identifier =
1490 port->aggregator->aggregator_identifier;
1492 /* update the new aggregator's parameters
1493 * if port was responsed from the end-user
1495 if (port->actor_oper_port_key & AD_DUPLEX_KEY_MASKS)
1496 /* if port is full duplex */
1497 port->aggregator->is_individual = false;
1498 else
1499 port->aggregator->is_individual = true;
1501 port->aggregator->actor_admin_aggregator_key =
1502 port->actor_admin_port_key;
1503 port->aggregator->actor_oper_aggregator_key =
1504 port->actor_oper_port_key;
1505 port->aggregator->partner_system =
1506 port->partner_oper.system;
1507 port->aggregator->partner_system_priority =
1508 port->partner_oper.system_priority;
1509 port->aggregator->partner_oper_aggregator_key = port->partner_oper.key;
1510 port->aggregator->receive_state = 1;
1511 port->aggregator->transmit_state = 1;
1512 port->aggregator->lag_ports = port;
1513 port->aggregator->num_of_ports++;
1515 /* mark this port as selected */
1516 port->sm_vars |= AD_PORT_SELECTED;
1518 netdev_dbg(bond->dev, "Port %d joined LAG %d(new LAG)\n",
1519 port->actor_port_number,
1520 port->aggregator->aggregator_identifier);
1521 } else {
1522 netdev_err(bond->dev, "Port %d (on %s) did not find a suitable aggregator\n",
1523 port->actor_port_number, port->slave->dev->name);
1526 /* if all aggregator's ports are READY_N == TRUE, set ready=TRUE
1527 * in all aggregator's ports, else set ready=FALSE in all
1528 * aggregator's ports
1530 __set_agg_ports_ready(port->aggregator,
1531 __agg_ports_are_ready(port->aggregator));
1533 aggregator = __get_first_agg(port);
1534 ad_agg_selection_logic(aggregator, update_slave_arr);
1536 if (!port->aggregator->is_active)
1537 port->actor_oper_port_state &= ~AD_STATE_SYNCHRONIZATION;
1540 /* Decide if "agg" is a better choice for the new active aggregator that
1541 * the current best, according to the ad_select policy.
1543 static struct aggregator *ad_agg_selection_test(struct aggregator *best,
1544 struct aggregator *curr)
1546 /* 0. If no best, select current.
1548 * 1. If the current agg is not individual, and the best is
1549 * individual, select current.
1551 * 2. If current agg is individual and the best is not, keep best.
1553 * 3. Therefore, current and best are both individual or both not
1554 * individual, so:
1556 * 3a. If current agg partner replied, and best agg partner did not,
1557 * select current.
1559 * 3b. If current agg partner did not reply and best agg partner
1560 * did reply, keep best.
1562 * 4. Therefore, current and best both have partner replies or
1563 * both do not, so perform selection policy:
1565 * BOND_AD_COUNT: Select by count of ports. If count is equal,
1566 * select by bandwidth.
1568 * BOND_AD_STABLE, BOND_AD_BANDWIDTH: Select by bandwidth.
1570 if (!best)
1571 return curr;
1573 if (!curr->is_individual && best->is_individual)
1574 return curr;
1576 if (curr->is_individual && !best->is_individual)
1577 return best;
1579 if (__agg_has_partner(curr) && !__agg_has_partner(best))
1580 return curr;
1582 if (!__agg_has_partner(curr) && __agg_has_partner(best))
1583 return best;
1585 switch (__get_agg_selection_mode(curr->lag_ports)) {
1586 case BOND_AD_COUNT:
1587 if (__agg_active_ports(curr) > __agg_active_ports(best))
1588 return curr;
1590 if (__agg_active_ports(curr) < __agg_active_ports(best))
1591 return best;
1593 /*FALLTHROUGH*/
1594 case BOND_AD_STABLE:
1595 case BOND_AD_BANDWIDTH:
1596 if (__get_agg_bandwidth(curr) > __get_agg_bandwidth(best))
1597 return curr;
1599 break;
1601 default:
1602 net_warn_ratelimited("%s: Impossible agg select mode %d\n",
1603 curr->slave->bond->dev->name,
1604 __get_agg_selection_mode(curr->lag_ports));
1605 break;
1608 return best;
1611 static int agg_device_up(const struct aggregator *agg)
1613 struct port *port = agg->lag_ports;
1615 if (!port)
1616 return 0;
1618 for (port = agg->lag_ports; port;
1619 port = port->next_port_in_aggregator) {
1620 if (netif_running(port->slave->dev) &&
1621 netif_carrier_ok(port->slave->dev))
1622 return 1;
1625 return 0;
1629 * ad_agg_selection_logic - select an aggregation group for a team
1630 * @aggregator: the aggregator we're looking at
1631 * @update_slave_arr: Does slave array need update?
1633 * It is assumed that only one aggregator may be selected for a team.
1635 * The logic of this function is to select the aggregator according to
1636 * the ad_select policy:
1638 * BOND_AD_STABLE: select the aggregator with the most ports attached to
1639 * it, and to reselect the active aggregator only if the previous
1640 * aggregator has no more ports related to it.
1642 * BOND_AD_BANDWIDTH: select the aggregator with the highest total
1643 * bandwidth, and reselect whenever a link state change takes place or the
1644 * set of slaves in the bond changes.
1646 * BOND_AD_COUNT: select the aggregator with largest number of ports
1647 * (slaves), and reselect whenever a link state change takes place or the
1648 * set of slaves in the bond changes.
1650 * FIXME: this function MUST be called with the first agg in the bond, or
1651 * __get_active_agg() won't work correctly. This function should be better
1652 * called with the bond itself, and retrieve the first agg from it.
1654 static void ad_agg_selection_logic(struct aggregator *agg,
1655 bool *update_slave_arr)
1657 struct aggregator *best, *active, *origin;
1658 struct bonding *bond = agg->slave->bond;
1659 struct list_head *iter;
1660 struct slave *slave;
1661 struct port *port;
1663 rcu_read_lock();
1664 origin = agg;
1665 active = __get_active_agg(agg);
1666 best = (active && agg_device_up(active)) ? active : NULL;
1668 bond_for_each_slave_rcu(bond, slave, iter) {
1669 agg = &(SLAVE_AD_INFO(slave)->aggregator);
1671 agg->is_active = 0;
1673 if (__agg_active_ports(agg) && agg_device_up(agg))
1674 best = ad_agg_selection_test(best, agg);
1677 if (best &&
1678 __get_agg_selection_mode(best->lag_ports) == BOND_AD_STABLE) {
1679 /* For the STABLE policy, don't replace the old active
1680 * aggregator if it's still active (it has an answering
1681 * partner) or if both the best and active don't have an
1682 * answering partner.
1684 if (active && active->lag_ports &&
1685 __agg_active_ports(active) &&
1686 (__agg_has_partner(active) ||
1687 (!__agg_has_partner(active) &&
1688 !__agg_has_partner(best)))) {
1689 if (!(!active->actor_oper_aggregator_key &&
1690 best->actor_oper_aggregator_key)) {
1691 best = NULL;
1692 active->is_active = 1;
1697 if (best && (best == active)) {
1698 best = NULL;
1699 active->is_active = 1;
1702 /* if there is new best aggregator, activate it */
1703 if (best) {
1704 netdev_dbg(bond->dev, "best Agg=%d; P=%d; a k=%d; p k=%d; Ind=%d; Act=%d\n",
1705 best->aggregator_identifier, best->num_of_ports,
1706 best->actor_oper_aggregator_key,
1707 best->partner_oper_aggregator_key,
1708 best->is_individual, best->is_active);
1709 netdev_dbg(bond->dev, "best ports %p slave %p %s\n",
1710 best->lag_ports, best->slave,
1711 best->slave ? best->slave->dev->name : "NULL");
1713 bond_for_each_slave_rcu(bond, slave, iter) {
1714 agg = &(SLAVE_AD_INFO(slave)->aggregator);
1716 netdev_dbg(bond->dev, "Agg=%d; P=%d; a k=%d; p k=%d; Ind=%d; Act=%d\n",
1717 agg->aggregator_identifier, agg->num_of_ports,
1718 agg->actor_oper_aggregator_key,
1719 agg->partner_oper_aggregator_key,
1720 agg->is_individual, agg->is_active);
1723 /* check if any partner replys */
1724 if (best->is_individual) {
1725 net_warn_ratelimited("%s: Warning: No 802.3ad response from the link partner for any adapters in the bond\n",
1726 best->slave ?
1727 best->slave->bond->dev->name : "NULL");
1730 best->is_active = 1;
1731 netdev_dbg(bond->dev, "LAG %d chosen as the active LAG\n",
1732 best->aggregator_identifier);
1733 netdev_dbg(bond->dev, "Agg=%d; P=%d; a k=%d; p k=%d; Ind=%d; Act=%d\n",
1734 best->aggregator_identifier, best->num_of_ports,
1735 best->actor_oper_aggregator_key,
1736 best->partner_oper_aggregator_key,
1737 best->is_individual, best->is_active);
1739 /* disable the ports that were related to the former
1740 * active_aggregator
1742 if (active) {
1743 for (port = active->lag_ports; port;
1744 port = port->next_port_in_aggregator) {
1745 __disable_port(port);
1748 /* Slave array needs update. */
1749 *update_slave_arr = true;
1752 /* if the selected aggregator is of join individuals
1753 * (partner_system is NULL), enable their ports
1755 active = __get_active_agg(origin);
1757 if (active) {
1758 if (!__agg_has_partner(active)) {
1759 for (port = active->lag_ports; port;
1760 port = port->next_port_in_aggregator) {
1761 __enable_port(port);
1766 rcu_read_unlock();
1768 bond_3ad_set_carrier(bond);
1772 * ad_clear_agg - clear a given aggregator's parameters
1773 * @aggregator: the aggregator we're looking at
1775 static void ad_clear_agg(struct aggregator *aggregator)
1777 if (aggregator) {
1778 aggregator->is_individual = false;
1779 aggregator->actor_admin_aggregator_key = 0;
1780 aggregator->actor_oper_aggregator_key = 0;
1781 eth_zero_addr(aggregator->partner_system.mac_addr_value);
1782 aggregator->partner_system_priority = 0;
1783 aggregator->partner_oper_aggregator_key = 0;
1784 aggregator->receive_state = 0;
1785 aggregator->transmit_state = 0;
1786 aggregator->lag_ports = NULL;
1787 aggregator->is_active = 0;
1788 aggregator->num_of_ports = 0;
1789 pr_debug("LAG %d was cleared\n",
1790 aggregator->aggregator_identifier);
1795 * ad_initialize_agg - initialize a given aggregator's parameters
1796 * @aggregator: the aggregator we're looking at
1798 static void ad_initialize_agg(struct aggregator *aggregator)
1800 if (aggregator) {
1801 ad_clear_agg(aggregator);
1803 eth_zero_addr(aggregator->aggregator_mac_address.mac_addr_value);
1804 aggregator->aggregator_identifier = 0;
1805 aggregator->slave = NULL;
1810 * ad_initialize_port - initialize a given port's parameters
1811 * @aggregator: the aggregator we're looking at
1812 * @lacp_fast: boolean. whether fast periodic should be used
1814 static void ad_initialize_port(struct port *port, int lacp_fast)
1816 static const struct port_params tmpl = {
1817 .system_priority = 0xffff,
1818 .key = 1,
1819 .port_number = 1,
1820 .port_priority = 0xff,
1821 .port_state = 1,
1823 static const struct lacpdu lacpdu = {
1824 .subtype = 0x01,
1825 .version_number = 0x01,
1826 .tlv_type_actor_info = 0x01,
1827 .actor_information_length = 0x14,
1828 .tlv_type_partner_info = 0x02,
1829 .partner_information_length = 0x14,
1830 .tlv_type_collector_info = 0x03,
1831 .collector_information_length = 0x10,
1832 .collector_max_delay = htons(AD_COLLECTOR_MAX_DELAY),
1835 if (port) {
1836 port->actor_port_priority = 0xff;
1837 port->actor_port_aggregator_identifier = 0;
1838 port->ntt = false;
1839 port->actor_admin_port_state = AD_STATE_AGGREGATION |
1840 AD_STATE_LACP_ACTIVITY;
1841 port->actor_oper_port_state = AD_STATE_AGGREGATION |
1842 AD_STATE_LACP_ACTIVITY;
1844 if (lacp_fast)
1845 port->actor_oper_port_state |= AD_STATE_LACP_TIMEOUT;
1847 memcpy(&port->partner_admin, &tmpl, sizeof(tmpl));
1848 memcpy(&port->partner_oper, &tmpl, sizeof(tmpl));
1850 port->is_enabled = true;
1851 /* private parameters */
1852 port->sm_vars = AD_PORT_BEGIN | AD_PORT_LACP_ENABLED;
1853 port->sm_rx_state = 0;
1854 port->sm_rx_timer_counter = 0;
1855 port->sm_periodic_state = 0;
1856 port->sm_periodic_timer_counter = 0;
1857 port->sm_mux_state = 0;
1858 port->sm_mux_timer_counter = 0;
1859 port->sm_tx_state = 0;
1860 port->aggregator = NULL;
1861 port->next_port_in_aggregator = NULL;
1862 port->transaction_id = 0;
1864 port->sm_churn_actor_timer_counter = 0;
1865 port->sm_churn_actor_state = 0;
1866 port->churn_actor_count = 0;
1867 port->sm_churn_partner_timer_counter = 0;
1868 port->sm_churn_partner_state = 0;
1869 port->churn_partner_count = 0;
1871 memcpy(&port->lacpdu, &lacpdu, sizeof(lacpdu));
1876 * ad_enable_collecting_distributing - enable a port's transmit/receive
1877 * @port: the port we're looking at
1878 * @update_slave_arr: Does slave array need update?
1880 * Enable @port if it's in an active aggregator
1882 static void ad_enable_collecting_distributing(struct port *port,
1883 bool *update_slave_arr)
1885 if (port->aggregator->is_active) {
1886 pr_debug("Enabling port %d(LAG %d)\n",
1887 port->actor_port_number,
1888 port->aggregator->aggregator_identifier);
1889 __enable_port(port);
1890 /* Slave array needs update */
1891 *update_slave_arr = true;
1896 * ad_disable_collecting_distributing - disable a port's transmit/receive
1897 * @port: the port we're looking at
1898 * @update_slave_arr: Does slave array need update?
1900 static void ad_disable_collecting_distributing(struct port *port,
1901 bool *update_slave_arr)
1903 if (port->aggregator &&
1904 !MAC_ADDRESS_EQUAL(&(port->aggregator->partner_system),
1905 &(null_mac_addr))) {
1906 pr_debug("Disabling port %d(LAG %d)\n",
1907 port->actor_port_number,
1908 port->aggregator->aggregator_identifier);
1909 __disable_port(port);
1910 /* Slave array needs an update */
1911 *update_slave_arr = true;
1916 * ad_marker_info_received - handle receive of a Marker information frame
1917 * @marker_info: Marker info received
1918 * @port: the port we're looking at
1920 static void ad_marker_info_received(struct bond_marker *marker_info,
1921 struct port *port)
1923 struct bond_marker marker;
1925 /* copy the received marker data to the response marker */
1926 memcpy(&marker, marker_info, sizeof(struct bond_marker));
1927 /* change the marker subtype to marker response */
1928 marker.tlv_type = AD_MARKER_RESPONSE_SUBTYPE;
1930 /* send the marker response */
1931 if (ad_marker_send(port, &marker) >= 0) {
1932 pr_debug("Sent Marker Response on port %d\n",
1933 port->actor_port_number);
1938 * ad_marker_response_received - handle receive of a marker response frame
1939 * @marker: marker PDU received
1940 * @port: the port we're looking at
1942 * This function does nothing since we decided not to implement send and handle
1943 * response for marker PDU's, in this stage, but only to respond to marker
1944 * information.
1946 static void ad_marker_response_received(struct bond_marker *marker,
1947 struct port *port)
1949 /* DO NOTHING, SINCE WE DECIDED NOT TO IMPLEMENT THIS FEATURE FOR NOW */
1952 /* ========= AD exported functions to the main bonding code ========= */
1954 /* Check aggregators status in team every T seconds */
1955 #define AD_AGGREGATOR_SELECTION_TIMER 8
1958 * bond_3ad_initiate_agg_selection - initate aggregator selection
1959 * @bond: bonding struct
1961 * Set the aggregation selection timer, to initiate an agg selection in
1962 * the very near future. Called during first initialization, and during
1963 * any down to up transitions of the bond.
1965 void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout)
1967 BOND_AD_INFO(bond).agg_select_timer = timeout;
1971 * bond_3ad_initialize - initialize a bond's 802.3ad parameters and structures
1972 * @bond: bonding struct to work on
1973 * @tick_resolution: tick duration (millisecond resolution)
1975 * Can be called only after the mac address of the bond is set.
1977 void bond_3ad_initialize(struct bonding *bond, u16 tick_resolution)
1979 /* check that the bond is not initialized yet */
1980 if (!MAC_ADDRESS_EQUAL(&(BOND_AD_INFO(bond).system.sys_mac_addr),
1981 bond->dev->dev_addr)) {
1983 BOND_AD_INFO(bond).aggregator_identifier = 0;
1985 BOND_AD_INFO(bond).system.sys_priority =
1986 bond->params.ad_actor_sys_prio;
1987 if (is_zero_ether_addr(bond->params.ad_actor_system))
1988 BOND_AD_INFO(bond).system.sys_mac_addr =
1989 *((struct mac_addr *)bond->dev->dev_addr);
1990 else
1991 BOND_AD_INFO(bond).system.sys_mac_addr =
1992 *((struct mac_addr *)bond->params.ad_actor_system);
1994 /* initialize how many times this module is called in one
1995 * second (should be about every 100ms)
1997 ad_ticks_per_sec = tick_resolution;
1999 bond_3ad_initiate_agg_selection(bond,
2000 AD_AGGREGATOR_SELECTION_TIMER *
2001 ad_ticks_per_sec);
2006 * bond_3ad_bind_slave - initialize a slave's port
2007 * @slave: slave struct to work on
2009 * Returns: 0 on success
2010 * < 0 on error
2012 void bond_3ad_bind_slave(struct slave *slave)
2014 struct bonding *bond = bond_get_bond_by_slave(slave);
2015 struct port *port;
2016 struct aggregator *aggregator;
2018 /* check that the slave has not been initialized yet. */
2019 if (SLAVE_AD_INFO(slave)->port.slave != slave) {
2021 /* port initialization */
2022 port = &(SLAVE_AD_INFO(slave)->port);
2024 ad_initialize_port(port, bond->params.lacp_fast);
2026 port->slave = slave;
2027 port->actor_port_number = SLAVE_AD_INFO(slave)->id;
2028 /* key is determined according to the link speed, duplex and
2029 * user key
2031 port->actor_admin_port_key = bond->params.ad_user_port_key << 6;
2032 ad_update_actor_keys(port, false);
2033 /* actor system is the bond's system */
2034 __ad_actor_update_port(port);
2035 /* tx timer(to verify that no more than MAX_TX_IN_SECOND
2036 * lacpdu's are sent in one second)
2038 port->sm_tx_timer_counter = ad_ticks_per_sec/AD_MAX_TX_IN_SECOND;
2040 __disable_port(port);
2042 /* aggregator initialization */
2043 aggregator = &(SLAVE_AD_INFO(slave)->aggregator);
2045 ad_initialize_agg(aggregator);
2047 aggregator->aggregator_mac_address = *((struct mac_addr *)bond->dev->dev_addr);
2048 aggregator->aggregator_identifier = ++BOND_AD_INFO(bond).aggregator_identifier;
2049 aggregator->slave = slave;
2050 aggregator->is_active = 0;
2051 aggregator->num_of_ports = 0;
2056 * bond_3ad_unbind_slave - deinitialize a slave's port
2057 * @slave: slave struct to work on
2059 * Search for the aggregator that is related to this port, remove the
2060 * aggregator and assign another aggregator for other port related to it
2061 * (if any), and remove the port.
2063 void bond_3ad_unbind_slave(struct slave *slave)
2065 struct port *port, *prev_port, *temp_port;
2066 struct aggregator *aggregator, *new_aggregator, *temp_aggregator;
2067 int select_new_active_agg = 0;
2068 struct bonding *bond = slave->bond;
2069 struct slave *slave_iter;
2070 struct list_head *iter;
2071 bool dummy_slave_update; /* Ignore this value as caller updates array */
2073 /* Sync against bond_3ad_state_machine_handler() */
2074 spin_lock_bh(&bond->mode_lock);
2075 aggregator = &(SLAVE_AD_INFO(slave)->aggregator);
2076 port = &(SLAVE_AD_INFO(slave)->port);
2078 /* if slave is null, the whole port is not initialized */
2079 if (!port->slave) {
2080 netdev_warn(bond->dev, "Trying to unbind an uninitialized port on %s\n",
2081 slave->dev->name);
2082 goto out;
2085 netdev_dbg(bond->dev, "Unbinding Link Aggregation Group %d\n",
2086 aggregator->aggregator_identifier);
2088 /* Tell the partner that this port is not suitable for aggregation */
2089 port->actor_oper_port_state &= ~AD_STATE_AGGREGATION;
2090 __update_lacpdu_from_port(port);
2091 ad_lacpdu_send(port);
2093 /* check if this aggregator is occupied */
2094 if (aggregator->lag_ports) {
2095 /* check if there are other ports related to this aggregator
2096 * except the port related to this slave(thats ensure us that
2097 * there is a reason to search for new aggregator, and that we
2098 * will find one
2100 if ((aggregator->lag_ports != port) ||
2101 (aggregator->lag_ports->next_port_in_aggregator)) {
2102 /* find new aggregator for the related port(s) */
2103 bond_for_each_slave(bond, slave_iter, iter) {
2104 new_aggregator = &(SLAVE_AD_INFO(slave_iter)->aggregator);
2105 /* if the new aggregator is empty, or it is
2106 * connected to our port only
2108 if (!new_aggregator->lag_ports ||
2109 ((new_aggregator->lag_ports == port) &&
2110 !new_aggregator->lag_ports->next_port_in_aggregator))
2111 break;
2113 if (!slave_iter)
2114 new_aggregator = NULL;
2116 /* if new aggregator found, copy the aggregator's
2117 * parameters and connect the related lag_ports to the
2118 * new aggregator
2120 if ((new_aggregator) && ((!new_aggregator->lag_ports) || ((new_aggregator->lag_ports == port) && !new_aggregator->lag_ports->next_port_in_aggregator))) {
2121 netdev_dbg(bond->dev, "Some port(s) related to LAG %d - replacing with LAG %d\n",
2122 aggregator->aggregator_identifier,
2123 new_aggregator->aggregator_identifier);
2125 if ((new_aggregator->lag_ports == port) &&
2126 new_aggregator->is_active) {
2127 netdev_info(bond->dev, "Removing an active aggregator\n");
2128 select_new_active_agg = 1;
2131 new_aggregator->is_individual = aggregator->is_individual;
2132 new_aggregator->actor_admin_aggregator_key = aggregator->actor_admin_aggregator_key;
2133 new_aggregator->actor_oper_aggregator_key = aggregator->actor_oper_aggregator_key;
2134 new_aggregator->partner_system = aggregator->partner_system;
2135 new_aggregator->partner_system_priority = aggregator->partner_system_priority;
2136 new_aggregator->partner_oper_aggregator_key = aggregator->partner_oper_aggregator_key;
2137 new_aggregator->receive_state = aggregator->receive_state;
2138 new_aggregator->transmit_state = aggregator->transmit_state;
2139 new_aggregator->lag_ports = aggregator->lag_ports;
2140 new_aggregator->is_active = aggregator->is_active;
2141 new_aggregator->num_of_ports = aggregator->num_of_ports;
2143 /* update the information that is written on
2144 * the ports about the aggregator
2146 for (temp_port = aggregator->lag_ports; temp_port;
2147 temp_port = temp_port->next_port_in_aggregator) {
2148 temp_port->aggregator = new_aggregator;
2149 temp_port->actor_port_aggregator_identifier = new_aggregator->aggregator_identifier;
2152 ad_clear_agg(aggregator);
2154 if (select_new_active_agg)
2155 ad_agg_selection_logic(__get_first_agg(port),
2156 &dummy_slave_update);
2157 } else {
2158 netdev_warn(bond->dev, "unbinding aggregator, and could not find a new aggregator for its ports\n");
2160 } else {
2161 /* in case that the only port related to this
2162 * aggregator is the one we want to remove
2164 select_new_active_agg = aggregator->is_active;
2165 ad_clear_agg(aggregator);
2166 if (select_new_active_agg) {
2167 netdev_info(bond->dev, "Removing an active aggregator\n");
2168 /* select new active aggregator */
2169 temp_aggregator = __get_first_agg(port);
2170 if (temp_aggregator)
2171 ad_agg_selection_logic(temp_aggregator,
2172 &dummy_slave_update);
2177 netdev_dbg(bond->dev, "Unbinding port %d\n", port->actor_port_number);
2179 /* find the aggregator that this port is connected to */
2180 bond_for_each_slave(bond, slave_iter, iter) {
2181 temp_aggregator = &(SLAVE_AD_INFO(slave_iter)->aggregator);
2182 prev_port = NULL;
2183 /* search the port in the aggregator's related ports */
2184 for (temp_port = temp_aggregator->lag_ports; temp_port;
2185 prev_port = temp_port,
2186 temp_port = temp_port->next_port_in_aggregator) {
2187 if (temp_port == port) {
2188 /* the aggregator found - detach the port from
2189 * this aggregator
2191 if (prev_port)
2192 prev_port->next_port_in_aggregator = temp_port->next_port_in_aggregator;
2193 else
2194 temp_aggregator->lag_ports = temp_port->next_port_in_aggregator;
2195 temp_aggregator->num_of_ports--;
2196 if (__agg_active_ports(temp_aggregator) == 0) {
2197 select_new_active_agg = temp_aggregator->is_active;
2198 ad_clear_agg(temp_aggregator);
2199 if (select_new_active_agg) {
2200 netdev_info(bond->dev, "Removing an active aggregator\n");
2201 /* select new active aggregator */
2202 ad_agg_selection_logic(__get_first_agg(port),
2203 &dummy_slave_update);
2206 break;
2210 port->slave = NULL;
2212 out:
2213 spin_unlock_bh(&bond->mode_lock);
2217 * bond_3ad_update_ad_actor_settings - reflect change of actor settings to ports
2218 * @bond: bonding struct to work on
2220 * If an ad_actor setting gets changed we need to update the individual port
2221 * settings so the bond device will use the new values when it gets upped.
2223 void bond_3ad_update_ad_actor_settings(struct bonding *bond)
2225 struct list_head *iter;
2226 struct slave *slave;
2228 ASSERT_RTNL();
2230 BOND_AD_INFO(bond).system.sys_priority = bond->params.ad_actor_sys_prio;
2231 if (is_zero_ether_addr(bond->params.ad_actor_system))
2232 BOND_AD_INFO(bond).system.sys_mac_addr =
2233 *((struct mac_addr *)bond->dev->dev_addr);
2234 else
2235 BOND_AD_INFO(bond).system.sys_mac_addr =
2236 *((struct mac_addr *)bond->params.ad_actor_system);
2238 spin_lock_bh(&bond->mode_lock);
2239 bond_for_each_slave(bond, slave, iter) {
2240 struct port *port = &(SLAVE_AD_INFO(slave))->port;
2242 __ad_actor_update_port(port);
2243 port->ntt = true;
2245 spin_unlock_bh(&bond->mode_lock);
2249 * bond_3ad_state_machine_handler - handle state machines timeout
2250 * @bond: bonding struct to work on
2252 * The state machine handling concept in this module is to check every tick
2253 * which state machine should operate any function. The execution order is
2254 * round robin, so when we have an interaction between state machines, the
2255 * reply of one to each other might be delayed until next tick.
2257 * This function also complete the initialization when the agg_select_timer
2258 * times out, and it selects an aggregator for the ports that are yet not
2259 * related to any aggregator, and selects the active aggregator for a bond.
2261 void bond_3ad_state_machine_handler(struct work_struct *work)
2263 struct bonding *bond = container_of(work, struct bonding,
2264 ad_work.work);
2265 struct aggregator *aggregator;
2266 struct list_head *iter;
2267 struct slave *slave;
2268 struct port *port;
2269 bool should_notify_rtnl = BOND_SLAVE_NOTIFY_LATER;
2270 bool update_slave_arr = false;
2272 /* Lock to protect data accessed by all (e.g., port->sm_vars) and
2273 * against running with bond_3ad_unbind_slave. ad_rx_machine may run
2274 * concurrently due to incoming LACPDU as well.
2276 spin_lock_bh(&bond->mode_lock);
2277 rcu_read_lock();
2279 /* check if there are any slaves */
2280 if (!bond_has_slaves(bond))
2281 goto re_arm;
2283 /* check if agg_select_timer timer after initialize is timed out */
2284 if (BOND_AD_INFO(bond).agg_select_timer &&
2285 !(--BOND_AD_INFO(bond).agg_select_timer)) {
2286 slave = bond_first_slave_rcu(bond);
2287 port = slave ? &(SLAVE_AD_INFO(slave)->port) : NULL;
2289 /* select the active aggregator for the bond */
2290 if (port) {
2291 if (!port->slave) {
2292 net_warn_ratelimited("%s: Warning: bond's first port is uninitialized\n",
2293 bond->dev->name);
2294 goto re_arm;
2297 aggregator = __get_first_agg(port);
2298 ad_agg_selection_logic(aggregator, &update_slave_arr);
2300 bond_3ad_set_carrier(bond);
2303 /* for each port run the state machines */
2304 bond_for_each_slave_rcu(bond, slave, iter) {
2305 port = &(SLAVE_AD_INFO(slave)->port);
2306 if (!port->slave) {
2307 net_warn_ratelimited("%s: Warning: Found an uninitialized port\n",
2308 bond->dev->name);
2309 goto re_arm;
2312 ad_rx_machine(NULL, port);
2313 ad_periodic_machine(port);
2314 ad_port_selection_logic(port, &update_slave_arr);
2315 ad_mux_machine(port, &update_slave_arr);
2316 ad_tx_machine(port);
2317 ad_churn_machine(port);
2319 /* turn off the BEGIN bit, since we already handled it */
2320 if (port->sm_vars & AD_PORT_BEGIN)
2321 port->sm_vars &= ~AD_PORT_BEGIN;
2324 re_arm:
2325 bond_for_each_slave_rcu(bond, slave, iter) {
2326 if (slave->should_notify) {
2327 should_notify_rtnl = BOND_SLAVE_NOTIFY_NOW;
2328 break;
2331 rcu_read_unlock();
2332 spin_unlock_bh(&bond->mode_lock);
2334 if (update_slave_arr)
2335 bond_slave_arr_work_rearm(bond, 0);
2337 if (should_notify_rtnl && rtnl_trylock()) {
2338 bond_slave_state_notify(bond);
2339 rtnl_unlock();
2341 queue_delayed_work(bond->wq, &bond->ad_work, ad_delta_in_ticks);
2345 * bond_3ad_rx_indication - handle a received frame
2346 * @lacpdu: received lacpdu
2347 * @slave: slave struct to work on
2348 * @length: length of the data received
2350 * It is assumed that frames that were sent on this NIC don't returned as new
2351 * received frames (loopback). Since only the payload is given to this
2352 * function, it check for loopback.
2354 static int bond_3ad_rx_indication(struct lacpdu *lacpdu, struct slave *slave,
2355 u16 length)
2357 struct port *port;
2358 int ret = RX_HANDLER_ANOTHER;
2360 if (length >= sizeof(struct lacpdu)) {
2362 port = &(SLAVE_AD_INFO(slave)->port);
2364 if (!port->slave) {
2365 net_warn_ratelimited("%s: Warning: port of slave %s is uninitialized\n",
2366 slave->dev->name, slave->bond->dev->name);
2367 return ret;
2370 switch (lacpdu->subtype) {
2371 case AD_TYPE_LACPDU:
2372 ret = RX_HANDLER_CONSUMED;
2373 netdev_dbg(slave->bond->dev,
2374 "Received LACPDU on port %d slave %s\n",
2375 port->actor_port_number,
2376 slave->dev->name);
2377 /* Protect against concurrent state machines */
2378 spin_lock(&slave->bond->mode_lock);
2379 ad_rx_machine(lacpdu, port);
2380 spin_unlock(&slave->bond->mode_lock);
2381 break;
2383 case AD_TYPE_MARKER:
2384 ret = RX_HANDLER_CONSUMED;
2385 /* No need to convert fields to Little Endian since we
2386 * don't use the marker's fields.
2389 switch (((struct bond_marker *)lacpdu)->tlv_type) {
2390 case AD_MARKER_INFORMATION_SUBTYPE:
2391 netdev_dbg(slave->bond->dev, "Received Marker Information on port %d\n",
2392 port->actor_port_number);
2393 ad_marker_info_received((struct bond_marker *)lacpdu, port);
2394 break;
2396 case AD_MARKER_RESPONSE_SUBTYPE:
2397 netdev_dbg(slave->bond->dev, "Received Marker Response on port %d\n",
2398 port->actor_port_number);
2399 ad_marker_response_received((struct bond_marker *)lacpdu, port);
2400 break;
2402 default:
2403 netdev_dbg(slave->bond->dev, "Received an unknown Marker subtype on slot %d\n",
2404 port->actor_port_number);
2408 return ret;
2412 * ad_update_actor_keys - Update the oper / admin keys for a port based on
2413 * its current speed and duplex settings.
2415 * @port: the port we'are looking at
2416 * @reset: Boolean to just reset the speed and the duplex part of the key
2418 * The logic to change the oper / admin keys is:
2419 * (a) A full duplex port can participate in LACP with partner.
2420 * (b) When the speed is changed, LACP need to be reinitiated.
2422 static void ad_update_actor_keys(struct port *port, bool reset)
2424 u8 duplex = 0;
2425 u16 ospeed = 0, speed = 0;
2426 u16 old_oper_key = port->actor_oper_port_key;
2428 port->actor_admin_port_key &= ~(AD_SPEED_KEY_MASKS|AD_DUPLEX_KEY_MASKS);
2429 if (!reset) {
2430 speed = __get_link_speed(port);
2431 ospeed = (old_oper_key & AD_SPEED_KEY_MASKS) >> 1;
2432 duplex = __get_duplex(port);
2433 port->actor_admin_port_key |= (speed << 1) | duplex;
2435 port->actor_oper_port_key = port->actor_admin_port_key;
2437 if (old_oper_key != port->actor_oper_port_key) {
2438 /* Only 'duplex' port participates in LACP */
2439 if (duplex)
2440 port->sm_vars |= AD_PORT_LACP_ENABLED;
2441 else
2442 port->sm_vars &= ~AD_PORT_LACP_ENABLED;
2444 if (!reset) {
2445 if (!speed) {
2446 netdev_err(port->slave->dev,
2447 "speed changed to 0 for port %s",
2448 port->slave->dev->name);
2449 } else if (duplex && ospeed != speed) {
2450 /* Speed change restarts LACP state-machine */
2451 port->sm_vars |= AD_PORT_BEGIN;
2458 * bond_3ad_adapter_speed_duplex_changed - handle a slave's speed / duplex
2459 * change indication
2461 * @slave: slave struct to work on
2463 * Handle reselection of aggregator (if needed) for this port.
2465 void bond_3ad_adapter_speed_duplex_changed(struct slave *slave)
2467 struct port *port;
2469 port = &(SLAVE_AD_INFO(slave)->port);
2471 /* if slave is null, the whole port is not initialized */
2472 if (!port->slave) {
2473 netdev_warn(slave->bond->dev,
2474 "speed/duplex changed for uninitialized port %s\n",
2475 slave->dev->name);
2476 return;
2479 spin_lock_bh(&slave->bond->mode_lock);
2480 ad_update_actor_keys(port, false);
2481 spin_unlock_bh(&slave->bond->mode_lock);
2482 netdev_dbg(slave->bond->dev, "Port %d slave %s changed speed/duplex\n",
2483 port->actor_port_number, slave->dev->name);
2487 * bond_3ad_handle_link_change - handle a slave's link status change indication
2488 * @slave: slave struct to work on
2489 * @status: whether the link is now up or down
2491 * Handle reselection of aggregator (if needed) for this port.
2493 void bond_3ad_handle_link_change(struct slave *slave, char link)
2495 struct aggregator *agg;
2496 struct port *port;
2497 bool dummy;
2499 port = &(SLAVE_AD_INFO(slave)->port);
2501 /* if slave is null, the whole port is not initialized */
2502 if (!port->slave) {
2503 netdev_warn(slave->bond->dev, "link status changed for uninitialized port on %s\n",
2504 slave->dev->name);
2505 return;
2508 spin_lock_bh(&slave->bond->mode_lock);
2509 /* on link down we are zeroing duplex and speed since
2510 * some of the adaptors(ce1000.lan) report full duplex/speed
2511 * instead of N/A(duplex) / 0(speed).
2513 * on link up we are forcing recheck on the duplex and speed since
2514 * some of he adaptors(ce1000.lan) report.
2516 if (link == BOND_LINK_UP) {
2517 port->is_enabled = true;
2518 ad_update_actor_keys(port, false);
2519 } else {
2520 /* link has failed */
2521 port->is_enabled = false;
2522 ad_update_actor_keys(port, true);
2524 agg = __get_first_agg(port);
2525 ad_agg_selection_logic(agg, &dummy);
2527 spin_unlock_bh(&slave->bond->mode_lock);
2529 netdev_dbg(slave->bond->dev, "Port %d changed link status to %s\n",
2530 port->actor_port_number,
2531 link == BOND_LINK_UP ? "UP" : "DOWN");
2533 /* RTNL is held and mode_lock is released so it's safe
2534 * to update slave_array here.
2536 bond_update_slave_arr(slave->bond, NULL);
2540 * bond_3ad_set_carrier - set link state for bonding master
2541 * @bond - bonding structure
2543 * if we have an active aggregator, we're up, if not, we're down.
2544 * Presumes that we cannot have an active aggregator if there are
2545 * no slaves with link up.
2547 * This behavior complies with IEEE 802.3 section 43.3.9.
2549 * Called by bond_set_carrier(). Return zero if carrier state does not
2550 * change, nonzero if it does.
2552 int bond_3ad_set_carrier(struct bonding *bond)
2554 struct aggregator *active;
2555 struct slave *first_slave;
2556 int ret = 1;
2558 rcu_read_lock();
2559 first_slave = bond_first_slave_rcu(bond);
2560 if (!first_slave) {
2561 ret = 0;
2562 goto out;
2564 active = __get_active_agg(&(SLAVE_AD_INFO(first_slave)->aggregator));
2565 if (active) {
2566 /* are enough slaves available to consider link up? */
2567 if (__agg_active_ports(active) < bond->params.min_links) {
2568 if (netif_carrier_ok(bond->dev)) {
2569 netif_carrier_off(bond->dev);
2570 goto out;
2572 } else if (!netif_carrier_ok(bond->dev)) {
2573 netif_carrier_on(bond->dev);
2574 goto out;
2576 } else if (netif_carrier_ok(bond->dev)) {
2577 netif_carrier_off(bond->dev);
2579 out:
2580 rcu_read_unlock();
2581 return ret;
2585 * __bond_3ad_get_active_agg_info - get information of the active aggregator
2586 * @bond: bonding struct to work on
2587 * @ad_info: ad_info struct to fill with the bond's info
2589 * Returns: 0 on success
2590 * < 0 on error
2592 int __bond_3ad_get_active_agg_info(struct bonding *bond,
2593 struct ad_info *ad_info)
2595 struct aggregator *aggregator = NULL;
2596 struct list_head *iter;
2597 struct slave *slave;
2598 struct port *port;
2600 bond_for_each_slave_rcu(bond, slave, iter) {
2601 port = &(SLAVE_AD_INFO(slave)->port);
2602 if (port->aggregator && port->aggregator->is_active) {
2603 aggregator = port->aggregator;
2604 break;
2608 if (!aggregator)
2609 return -1;
2611 ad_info->aggregator_id = aggregator->aggregator_identifier;
2612 ad_info->ports = __agg_active_ports(aggregator);
2613 ad_info->actor_key = aggregator->actor_oper_aggregator_key;
2614 ad_info->partner_key = aggregator->partner_oper_aggregator_key;
2615 ether_addr_copy(ad_info->partner_system,
2616 aggregator->partner_system.mac_addr_value);
2617 return 0;
2620 int bond_3ad_get_active_agg_info(struct bonding *bond, struct ad_info *ad_info)
2622 int ret;
2624 rcu_read_lock();
2625 ret = __bond_3ad_get_active_agg_info(bond, ad_info);
2626 rcu_read_unlock();
2628 return ret;
2631 int bond_3ad_lacpdu_recv(const struct sk_buff *skb, struct bonding *bond,
2632 struct slave *slave)
2634 struct lacpdu *lacpdu, _lacpdu;
2636 if (skb->protocol != PKT_TYPE_LACPDU)
2637 return RX_HANDLER_ANOTHER;
2639 if (!MAC_ADDRESS_EQUAL(eth_hdr(skb)->h_dest, lacpdu_mcast_addr))
2640 return RX_HANDLER_ANOTHER;
2642 lacpdu = skb_header_pointer(skb, 0, sizeof(_lacpdu), &_lacpdu);
2643 if (!lacpdu)
2644 return RX_HANDLER_ANOTHER;
2646 return bond_3ad_rx_indication(lacpdu, slave, skb->len);
2650 * bond_3ad_update_lacp_rate - change the lacp rate
2651 * @bond - bonding struct
2653 * When modify lacp_rate parameter via sysfs,
2654 * update actor_oper_port_state of each port.
2656 * Hold bond->mode_lock,
2657 * so we can modify port->actor_oper_port_state,
2658 * no matter bond is up or down.
2660 void bond_3ad_update_lacp_rate(struct bonding *bond)
2662 struct port *port = NULL;
2663 struct list_head *iter;
2664 struct slave *slave;
2665 int lacp_fast;
2667 lacp_fast = bond->params.lacp_fast;
2668 spin_lock_bh(&bond->mode_lock);
2669 bond_for_each_slave(bond, slave, iter) {
2670 port = &(SLAVE_AD_INFO(slave)->port);
2671 if (lacp_fast)
2672 port->actor_oper_port_state |= AD_STATE_LACP_TIMEOUT;
2673 else
2674 port->actor_oper_port_state &= ~AD_STATE_LACP_TIMEOUT;
2676 spin_unlock_bh(&bond->mode_lock);