xref: /openbmc/linux/drivers/net/bonding/bond_3ad.c (revision c3e23538)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright(c) 1999 - 2004 Intel Corporation. All rights reserved.
4  */
5 
6 #include <linux/skbuff.h>
7 #include <linux/if_ether.h>
8 #include <linux/netdevice.h>
9 #include <linux/spinlock.h>
10 #include <linux/ethtool.h>
11 #include <linux/etherdevice.h>
12 #include <linux/if_bonding.h>
13 #include <linux/pkt_sched.h>
14 #include <net/net_namespace.h>
15 #include <net/bonding.h>
16 #include <net/bond_3ad.h>
17 #include <net/netlink.h>
18 
19 /* General definitions */
20 #define AD_SHORT_TIMEOUT           1
21 #define AD_LONG_TIMEOUT            0
22 #define AD_STANDBY                 0x2
23 #define AD_MAX_TX_IN_SECOND        3
24 #define AD_COLLECTOR_MAX_DELAY     0
25 
26 /* Timer definitions (43.4.4 in the 802.3ad standard) */
27 #define AD_FAST_PERIODIC_TIME      1
28 #define AD_SLOW_PERIODIC_TIME      30
29 #define AD_SHORT_TIMEOUT_TIME      (3*AD_FAST_PERIODIC_TIME)
30 #define AD_LONG_TIMEOUT_TIME       (3*AD_SLOW_PERIODIC_TIME)
31 #define AD_CHURN_DETECTION_TIME    60
32 #define AD_AGGREGATE_WAIT_TIME     2
33 
34 /* Port Variables definitions used by the State Machines (43.4.7 in the
35  * 802.3ad standard)
36  */
37 #define AD_PORT_BEGIN           0x1
38 #define AD_PORT_LACP_ENABLED    0x2
39 #define AD_PORT_ACTOR_CHURN     0x4
40 #define AD_PORT_PARTNER_CHURN   0x8
41 #define AD_PORT_READY           0x10
42 #define AD_PORT_READY_N         0x20
43 #define AD_PORT_MATCHED         0x40
44 #define AD_PORT_STANDBY         0x80
45 #define AD_PORT_SELECTED        0x100
46 #define AD_PORT_MOVED           0x200
47 #define AD_PORT_CHURNED         (AD_PORT_ACTOR_CHURN | AD_PORT_PARTNER_CHURN)
48 
49 /* Port Key definitions
50  * key is determined according to the link speed, duplex and
51  * user key (which is yet not supported)
52  *           --------------------------------------------------------------
53  * Port key  | User key (10 bits)           | Speed (5 bits)      | Duplex|
54  *           --------------------------------------------------------------
55  *           |15                           6|5                   1|0
56  */
57 #define  AD_DUPLEX_KEY_MASKS    0x1
58 #define  AD_SPEED_KEY_MASKS     0x3E
59 #define  AD_USER_KEY_MASKS      0xFFC0
60 
61 enum ad_link_speed_type {
62 	AD_LINK_SPEED_1MBPS = 1,
63 	AD_LINK_SPEED_10MBPS,
64 	AD_LINK_SPEED_100MBPS,
65 	AD_LINK_SPEED_1000MBPS,
66 	AD_LINK_SPEED_2500MBPS,
67 	AD_LINK_SPEED_5000MBPS,
68 	AD_LINK_SPEED_10000MBPS,
69 	AD_LINK_SPEED_14000MBPS,
70 	AD_LINK_SPEED_20000MBPS,
71 	AD_LINK_SPEED_25000MBPS,
72 	AD_LINK_SPEED_40000MBPS,
73 	AD_LINK_SPEED_50000MBPS,
74 	AD_LINK_SPEED_56000MBPS,
75 	AD_LINK_SPEED_100000MBPS,
76 	AD_LINK_SPEED_200000MBPS,
77 	AD_LINK_SPEED_400000MBPS,
78 };
79 
80 /* compare MAC addresses */
81 #define MAC_ADDRESS_EQUAL(A, B)	\
82 	ether_addr_equal_64bits((const u8 *)A, (const u8 *)B)
83 
84 static const u8 null_mac_addr[ETH_ALEN + 2] __long_aligned = {
85 	0, 0, 0, 0, 0, 0
86 };
87 static u16 ad_ticks_per_sec;
88 static const int ad_delta_in_ticks = (AD_TIMER_INTERVAL * HZ) / 1000;
89 
90 static const u8 lacpdu_mcast_addr[ETH_ALEN + 2] __long_aligned =
91 	MULTICAST_LACPDU_ADDR;
92 
93 /* ================= main 802.3ad protocol functions ================== */
94 static int ad_lacpdu_send(struct port *port);
95 static int ad_marker_send(struct port *port, struct bond_marker *marker);
96 static void ad_mux_machine(struct port *port, bool *update_slave_arr);
97 static void ad_rx_machine(struct lacpdu *lacpdu, struct port *port);
98 static void ad_tx_machine(struct port *port);
99 static void ad_periodic_machine(struct port *port);
100 static void ad_port_selection_logic(struct port *port, bool *update_slave_arr);
101 static void ad_agg_selection_logic(struct aggregator *aggregator,
102 				   bool *update_slave_arr);
103 static void ad_clear_agg(struct aggregator *aggregator);
104 static void ad_initialize_agg(struct aggregator *aggregator);
105 static void ad_initialize_port(struct port *port, int lacp_fast);
106 static void ad_enable_collecting_distributing(struct port *port,
107 					      bool *update_slave_arr);
108 static void ad_disable_collecting_distributing(struct port *port,
109 					       bool *update_slave_arr);
110 static void ad_marker_info_received(struct bond_marker *marker_info,
111 				    struct port *port);
112 static void ad_marker_response_received(struct bond_marker *marker,
113 					struct port *port);
114 static void ad_update_actor_keys(struct port *port, bool reset);
115 
116 
117 /* ================= api to bonding and kernel code ================== */
118 
119 /**
120  * __get_bond_by_port - get the port's bonding struct
121  * @port: the port we're looking at
122  *
123  * Return @port's bonding struct, or %NULL if it can't be found.
124  */
125 static inline struct bonding *__get_bond_by_port(struct port *port)
126 {
127 	if (port->slave == NULL)
128 		return NULL;
129 
130 	return bond_get_bond_by_slave(port->slave);
131 }
132 
133 /**
134  * __get_first_agg - get the first aggregator in the bond
135  * @port: the port we're looking at
136  *
137  * Return the aggregator of the first slave in @bond, or %NULL if it can't be
138  * found.
139  * The caller must hold RCU or RTNL lock.
140  */
141 static inline struct aggregator *__get_first_agg(struct port *port)
142 {
143 	struct bonding *bond = __get_bond_by_port(port);
144 	struct slave *first_slave;
145 	struct aggregator *agg;
146 
147 	/* If there's no bond for this port, or bond has no slaves */
148 	if (bond == NULL)
149 		return NULL;
150 
151 	rcu_read_lock();
152 	first_slave = bond_first_slave_rcu(bond);
153 	agg = first_slave ? &(SLAVE_AD_INFO(first_slave)->aggregator) : NULL;
154 	rcu_read_unlock();
155 
156 	return agg;
157 }
158 
159 /**
160  * __agg_has_partner - see if we have a partner
161  * @agg: the agregator we're looking at
162  *
163  * Return nonzero if aggregator has a partner (denoted by a non-zero ether
164  * address for the partner). Return 0 if not.
165  */
166 static inline int __agg_has_partner(struct aggregator *agg)
167 {
168 	return !is_zero_ether_addr(agg->partner_system.mac_addr_value);
169 }
170 
171 /**
172  * __disable_port - disable the port's slave
173  * @port: the port we're looking at
174  */
175 static inline void __disable_port(struct port *port)
176 {
177 	bond_set_slave_inactive_flags(port->slave, BOND_SLAVE_NOTIFY_LATER);
178 }
179 
180 /**
181  * __enable_port - enable the port's slave, if it's up
182  * @port: the port we're looking at
183  */
184 static inline void __enable_port(struct port *port)
185 {
186 	struct slave *slave = port->slave;
187 
188 	if ((slave->link == BOND_LINK_UP) && bond_slave_is_up(slave))
189 		bond_set_slave_active_flags(slave, BOND_SLAVE_NOTIFY_LATER);
190 }
191 
192 /**
193  * __port_is_enabled - check if the port's slave is in active state
194  * @port: the port we're looking at
195  */
196 static inline int __port_is_enabled(struct port *port)
197 {
198 	return bond_is_active_slave(port->slave);
199 }
200 
201 /**
202  * __get_agg_selection_mode - get the aggregator selection mode
203  * @port: the port we're looking at
204  *
205  * Get the aggregator selection mode. Can be %STABLE, %BANDWIDTH or %COUNT.
206  */
207 static inline u32 __get_agg_selection_mode(struct port *port)
208 {
209 	struct bonding *bond = __get_bond_by_port(port);
210 
211 	if (bond == NULL)
212 		return BOND_AD_STABLE;
213 
214 	return bond->params.ad_select;
215 }
216 
217 /**
218  * __check_agg_selection_timer - check if the selection timer has expired
219  * @port: the port we're looking at
220  */
221 static inline int __check_agg_selection_timer(struct port *port)
222 {
223 	struct bonding *bond = __get_bond_by_port(port);
224 
225 	if (bond == NULL)
226 		return 0;
227 
228 	return BOND_AD_INFO(bond).agg_select_timer ? 1 : 0;
229 }
230 
231 /**
232  * __get_link_speed - get a port's speed
233  * @port: the port we're looking at
234  *
235  * Return @port's speed in 802.3ad enum format. i.e. one of:
236  *     0,
237  *     %AD_LINK_SPEED_10MBPS,
238  *     %AD_LINK_SPEED_100MBPS,
239  *     %AD_LINK_SPEED_1000MBPS,
240  *     %AD_LINK_SPEED_2500MBPS,
241  *     %AD_LINK_SPEED_5000MBPS,
242  *     %AD_LINK_SPEED_10000MBPS
243  *     %AD_LINK_SPEED_14000MBPS,
244  *     %AD_LINK_SPEED_20000MBPS
245  *     %AD_LINK_SPEED_25000MBPS
246  *     %AD_LINK_SPEED_40000MBPS
247  *     %AD_LINK_SPEED_50000MBPS
248  *     %AD_LINK_SPEED_56000MBPS
249  *     %AD_LINK_SPEED_100000MBPS
250  *     %AD_LINK_SPEED_200000MBPS
251  *     %AD_LINK_SPEED_400000MBPS
252  */
253 static u16 __get_link_speed(struct port *port)
254 {
255 	struct slave *slave = port->slave;
256 	u16 speed;
257 
258 	/* this if covers only a special case: when the configuration starts
259 	 * with link down, it sets the speed to 0.
260 	 * This is done in spite of the fact that the e100 driver reports 0
261 	 * to be compatible with MVT in the future.
262 	 */
263 	if (slave->link != BOND_LINK_UP)
264 		speed = 0;
265 	else {
266 		switch (slave->speed) {
267 		case SPEED_10:
268 			speed = AD_LINK_SPEED_10MBPS;
269 			break;
270 
271 		case SPEED_100:
272 			speed = AD_LINK_SPEED_100MBPS;
273 			break;
274 
275 		case SPEED_1000:
276 			speed = AD_LINK_SPEED_1000MBPS;
277 			break;
278 
279 		case SPEED_2500:
280 			speed = AD_LINK_SPEED_2500MBPS;
281 			break;
282 
283 		case SPEED_5000:
284 			speed = AD_LINK_SPEED_5000MBPS;
285 			break;
286 
287 		case SPEED_10000:
288 			speed = AD_LINK_SPEED_10000MBPS;
289 			break;
290 
291 		case SPEED_14000:
292 			speed = AD_LINK_SPEED_14000MBPS;
293 			break;
294 
295 		case SPEED_20000:
296 			speed = AD_LINK_SPEED_20000MBPS;
297 			break;
298 
299 		case SPEED_25000:
300 			speed = AD_LINK_SPEED_25000MBPS;
301 			break;
302 
303 		case SPEED_40000:
304 			speed = AD_LINK_SPEED_40000MBPS;
305 			break;
306 
307 		case SPEED_50000:
308 			speed = AD_LINK_SPEED_50000MBPS;
309 			break;
310 
311 		case SPEED_56000:
312 			speed = AD_LINK_SPEED_56000MBPS;
313 			break;
314 
315 		case SPEED_100000:
316 			speed = AD_LINK_SPEED_100000MBPS;
317 			break;
318 
319 		case SPEED_200000:
320 			speed = AD_LINK_SPEED_200000MBPS;
321 			break;
322 
323 		case SPEED_400000:
324 			speed = AD_LINK_SPEED_400000MBPS;
325 			break;
326 
327 		default:
328 			/* unknown speed value from ethtool. shouldn't happen */
329 			if (slave->speed != SPEED_UNKNOWN)
330 				pr_err_once("%s: (slave %s): unknown ethtool speed (%d) for port %d (set it to 0)\n",
331 					    slave->bond->dev->name,
332 					    slave->dev->name, slave->speed,
333 					    port->actor_port_number);
334 			speed = 0;
335 			break;
336 		}
337 	}
338 
339 	slave_dbg(slave->bond->dev, slave->dev, "Port %d Received link speed %d update from adapter\n",
340 		  port->actor_port_number, speed);
341 	return speed;
342 }
343 
344 /**
345  * __get_duplex - get a port's duplex
346  * @port: the port we're looking at
347  *
348  * Return @port's duplex in 802.3ad bitmask format. i.e.:
349  *     0x01 if in full duplex
350  *     0x00 otherwise
351  */
352 static u8 __get_duplex(struct port *port)
353 {
354 	struct slave *slave = port->slave;
355 	u8 retval = 0x0;
356 
357 	/* handling a special case: when the configuration starts with
358 	 * link down, it sets the duplex to 0.
359 	 */
360 	if (slave->link == BOND_LINK_UP) {
361 		switch (slave->duplex) {
362 		case DUPLEX_FULL:
363 			retval = 0x1;
364 			slave_dbg(slave->bond->dev, slave->dev, "Port %d Received status full duplex update from adapter\n",
365 				  port->actor_port_number);
366 			break;
367 		case DUPLEX_HALF:
368 		default:
369 			retval = 0x0;
370 			slave_dbg(slave->bond->dev, slave->dev, "Port %d Received status NOT full duplex update from adapter\n",
371 				  port->actor_port_number);
372 			break;
373 		}
374 	}
375 	return retval;
376 }
377 
378 static void __ad_actor_update_port(struct port *port)
379 {
380 	const struct bonding *bond = bond_get_bond_by_slave(port->slave);
381 
382 	port->actor_system = BOND_AD_INFO(bond).system.sys_mac_addr;
383 	port->actor_system_priority = BOND_AD_INFO(bond).system.sys_priority;
384 }
385 
386 /* Conversions */
387 
388 /**
389  * __ad_timer_to_ticks - convert a given timer type to AD module ticks
390  * @timer_type:	which timer to operate
391  * @par: timer parameter. see below
392  *
393  * If @timer_type is %current_while_timer, @par indicates long/short timer.
394  * If @timer_type is %periodic_timer, @par is one of %FAST_PERIODIC_TIME,
395  *						     %SLOW_PERIODIC_TIME.
396  */
397 static u16 __ad_timer_to_ticks(u16 timer_type, u16 par)
398 {
399 	u16 retval = 0; /* to silence the compiler */
400 
401 	switch (timer_type) {
402 	case AD_CURRENT_WHILE_TIMER:	/* for rx machine usage */
403 		if (par)
404 			retval = (AD_SHORT_TIMEOUT_TIME*ad_ticks_per_sec);
405 		else
406 			retval = (AD_LONG_TIMEOUT_TIME*ad_ticks_per_sec);
407 		break;
408 	case AD_ACTOR_CHURN_TIMER:	/* for local churn machine */
409 		retval = (AD_CHURN_DETECTION_TIME*ad_ticks_per_sec);
410 		break;
411 	case AD_PERIODIC_TIMER:		/* for periodic machine */
412 		retval = (par*ad_ticks_per_sec); /* long timeout */
413 		break;
414 	case AD_PARTNER_CHURN_TIMER:	/* for remote churn machine */
415 		retval = (AD_CHURN_DETECTION_TIME*ad_ticks_per_sec);
416 		break;
417 	case AD_WAIT_WHILE_TIMER:	/* for selection machine */
418 		retval = (AD_AGGREGATE_WAIT_TIME*ad_ticks_per_sec);
419 		break;
420 	}
421 
422 	return retval;
423 }
424 
425 
426 /* ================= ad_rx_machine helper functions ================== */
427 
428 /**
429  * __choose_matched - update a port's matched variable from a received lacpdu
430  * @lacpdu: the lacpdu we've received
431  * @port: the port we're looking at
432  *
433  * Update the value of the matched variable, using parameter values from a
434  * newly received lacpdu. Parameter values for the partner carried in the
435  * received PDU are compared with the corresponding operational parameter
436  * values for the actor. Matched is set to TRUE if all of these parameters
437  * match and the PDU parameter partner_state.aggregation has the same value as
438  * actor_oper_port_state.aggregation and lacp will actively maintain the link
439  * in the aggregation. Matched is also set to TRUE if the value of
440  * actor_state.aggregation in the received PDU is set to FALSE, i.e., indicates
441  * an individual link and lacp will actively maintain the link. Otherwise,
442  * matched is set to FALSE. LACP is considered to be actively maintaining the
443  * link if either the PDU's actor_state.lacp_activity variable is TRUE or both
444  * the actor's actor_oper_port_state.lacp_activity and the PDU's
445  * partner_state.lacp_activity variables are TRUE.
446  *
447  * Note: the AD_PORT_MATCHED "variable" is not specified by 802.3ad; it is
448  * used here to implement the language from 802.3ad 43.4.9 that requires
449  * recordPDU to "match" the LACPDU parameters to the stored values.
450  */
451 static void __choose_matched(struct lacpdu *lacpdu, struct port *port)
452 {
453 	/* check if all parameters are alike
454 	 * or this is individual link(aggregation == FALSE)
455 	 * then update the state machine Matched variable.
456 	 */
457 	if (((ntohs(lacpdu->partner_port) == port->actor_port_number) &&
458 	     (ntohs(lacpdu->partner_port_priority) == port->actor_port_priority) &&
459 	     MAC_ADDRESS_EQUAL(&(lacpdu->partner_system), &(port->actor_system)) &&
460 	     (ntohs(lacpdu->partner_system_priority) == port->actor_system_priority) &&
461 	     (ntohs(lacpdu->partner_key) == port->actor_oper_port_key) &&
462 	     ((lacpdu->partner_state & LACP_STATE_AGGREGATION) == (port->actor_oper_port_state & LACP_STATE_AGGREGATION))) ||
463 	    ((lacpdu->actor_state & LACP_STATE_AGGREGATION) == 0)
464 		) {
465 		port->sm_vars |= AD_PORT_MATCHED;
466 	} else {
467 		port->sm_vars &= ~AD_PORT_MATCHED;
468 	}
469 }
470 
471 /**
472  * __record_pdu - record parameters from a received lacpdu
473  * @lacpdu: the lacpdu we've received
474  * @port: the port we're looking at
475  *
476  * Record the parameter values for the Actor carried in a received lacpdu as
477  * the current partner operational parameter values and sets
478  * actor_oper_port_state.defaulted to FALSE.
479  */
480 static void __record_pdu(struct lacpdu *lacpdu, struct port *port)
481 {
482 	if (lacpdu && port) {
483 		struct port_params *partner = &port->partner_oper;
484 
485 		__choose_matched(lacpdu, port);
486 		/* record the new parameter values for the partner
487 		 * operational
488 		 */
489 		partner->port_number = ntohs(lacpdu->actor_port);
490 		partner->port_priority = ntohs(lacpdu->actor_port_priority);
491 		partner->system = lacpdu->actor_system;
492 		partner->system_priority = ntohs(lacpdu->actor_system_priority);
493 		partner->key = ntohs(lacpdu->actor_key);
494 		partner->port_state = lacpdu->actor_state;
495 
496 		/* set actor_oper_port_state.defaulted to FALSE */
497 		port->actor_oper_port_state &= ~LACP_STATE_DEFAULTED;
498 
499 		/* set the partner sync. to on if the partner is sync,
500 		 * and the port is matched
501 		 */
502 		if ((port->sm_vars & AD_PORT_MATCHED) &&
503 		    (lacpdu->actor_state & LACP_STATE_SYNCHRONIZATION)) {
504 			partner->port_state |= LACP_STATE_SYNCHRONIZATION;
505 			slave_dbg(port->slave->bond->dev, port->slave->dev,
506 				  "partner sync=1\n");
507 		} else {
508 			partner->port_state &= ~LACP_STATE_SYNCHRONIZATION;
509 			slave_dbg(port->slave->bond->dev, port->slave->dev,
510 				  "partner sync=0\n");
511 		}
512 	}
513 }
514 
515 /**
516  * __record_default - record default parameters
517  * @port: the port we're looking at
518  *
519  * This function records the default parameter values for the partner carried
520  * in the Partner Admin parameters as the current partner operational parameter
521  * values and sets actor_oper_port_state.defaulted to TRUE.
522  */
523 static void __record_default(struct port *port)
524 {
525 	if (port) {
526 		/* record the partner admin parameters */
527 		memcpy(&port->partner_oper, &port->partner_admin,
528 		       sizeof(struct port_params));
529 
530 		/* set actor_oper_port_state.defaulted to true */
531 		port->actor_oper_port_state |= LACP_STATE_DEFAULTED;
532 	}
533 }
534 
535 /**
536  * __update_selected - update a port's Selected variable from a received lacpdu
537  * @lacpdu: the lacpdu we've received
538  * @port: the port we're looking at
539  *
540  * Update the value of the selected variable, using parameter values from a
541  * newly received lacpdu. The parameter values for the Actor carried in the
542  * received PDU are compared with the corresponding operational parameter
543  * values for the ports partner. If one or more of the comparisons shows that
544  * the value(s) received in the PDU differ from the current operational values,
545  * then selected is set to FALSE and actor_oper_port_state.synchronization is
546  * set to out_of_sync. Otherwise, selected remains unchanged.
547  */
548 static void __update_selected(struct lacpdu *lacpdu, struct port *port)
549 {
550 	if (lacpdu && port) {
551 		const struct port_params *partner = &port->partner_oper;
552 
553 		/* check if any parameter is different then
554 		 * update the state machine selected variable.
555 		 */
556 		if (ntohs(lacpdu->actor_port) != partner->port_number ||
557 		    ntohs(lacpdu->actor_port_priority) != partner->port_priority ||
558 		    !MAC_ADDRESS_EQUAL(&lacpdu->actor_system, &partner->system) ||
559 		    ntohs(lacpdu->actor_system_priority) != partner->system_priority ||
560 		    ntohs(lacpdu->actor_key) != partner->key ||
561 		    (lacpdu->actor_state & LACP_STATE_AGGREGATION) != (partner->port_state & LACP_STATE_AGGREGATION)) {
562 			port->sm_vars &= ~AD_PORT_SELECTED;
563 		}
564 	}
565 }
566 
567 /**
568  * __update_default_selected - update a port's Selected variable from Partner
569  * @port: the port we're looking at
570  *
571  * This function updates the value of the selected variable, using the partner
572  * administrative parameter values. The administrative values are compared with
573  * the corresponding operational parameter values for the partner. If one or
574  * more of the comparisons shows that the administrative value(s) differ from
575  * the current operational values, then Selected is set to FALSE and
576  * actor_oper_port_state.synchronization is set to OUT_OF_SYNC. Otherwise,
577  * Selected remains unchanged.
578  */
579 static void __update_default_selected(struct port *port)
580 {
581 	if (port) {
582 		const struct port_params *admin = &port->partner_admin;
583 		const struct port_params *oper = &port->partner_oper;
584 
585 		/* check if any parameter is different then
586 		 * update the state machine selected variable.
587 		 */
588 		if (admin->port_number != oper->port_number ||
589 		    admin->port_priority != oper->port_priority ||
590 		    !MAC_ADDRESS_EQUAL(&admin->system, &oper->system) ||
591 		    admin->system_priority != oper->system_priority ||
592 		    admin->key != oper->key ||
593 		    (admin->port_state & LACP_STATE_AGGREGATION)
594 			!= (oper->port_state & LACP_STATE_AGGREGATION)) {
595 			port->sm_vars &= ~AD_PORT_SELECTED;
596 		}
597 	}
598 }
599 
600 /**
601  * __update_ntt - update a port's ntt variable from a received lacpdu
602  * @lacpdu: the lacpdu we've received
603  * @port: the port we're looking at
604  *
605  * Updates the value of the ntt variable, using parameter values from a newly
606  * received lacpdu. The parameter values for the partner carried in the
607  * received PDU are compared with the corresponding operational parameter
608  * values for the Actor. If one or more of the comparisons shows that the
609  * value(s) received in the PDU differ from the current operational values,
610  * then ntt is set to TRUE. Otherwise, ntt remains unchanged.
611  */
612 static void __update_ntt(struct lacpdu *lacpdu, struct port *port)
613 {
614 	/* validate lacpdu and port */
615 	if (lacpdu && port) {
616 		/* check if any parameter is different then
617 		 * update the port->ntt.
618 		 */
619 		if ((ntohs(lacpdu->partner_port) != port->actor_port_number) ||
620 		    (ntohs(lacpdu->partner_port_priority) != port->actor_port_priority) ||
621 		    !MAC_ADDRESS_EQUAL(&(lacpdu->partner_system), &(port->actor_system)) ||
622 		    (ntohs(lacpdu->partner_system_priority) != port->actor_system_priority) ||
623 		    (ntohs(lacpdu->partner_key) != port->actor_oper_port_key) ||
624 		    ((lacpdu->partner_state & LACP_STATE_LACP_ACTIVITY) != (port->actor_oper_port_state & LACP_STATE_LACP_ACTIVITY)) ||
625 		    ((lacpdu->partner_state & LACP_STATE_LACP_TIMEOUT) != (port->actor_oper_port_state & LACP_STATE_LACP_TIMEOUT)) ||
626 		    ((lacpdu->partner_state & LACP_STATE_SYNCHRONIZATION) != (port->actor_oper_port_state & LACP_STATE_SYNCHRONIZATION)) ||
627 		    ((lacpdu->partner_state & LACP_STATE_AGGREGATION) != (port->actor_oper_port_state & LACP_STATE_AGGREGATION))
628 		   ) {
629 			port->ntt = true;
630 		}
631 	}
632 }
633 
634 /**
635  * __agg_ports_are_ready - check if all ports in an aggregator are ready
636  * @aggregator: the aggregator we're looking at
637  *
638  */
639 static int __agg_ports_are_ready(struct aggregator *aggregator)
640 {
641 	struct port *port;
642 	int retval = 1;
643 
644 	if (aggregator) {
645 		/* scan all ports in this aggregator to verfy if they are
646 		 * all ready.
647 		 */
648 		for (port = aggregator->lag_ports;
649 		     port;
650 		     port = port->next_port_in_aggregator) {
651 			if (!(port->sm_vars & AD_PORT_READY_N)) {
652 				retval = 0;
653 				break;
654 			}
655 		}
656 	}
657 
658 	return retval;
659 }
660 
661 /**
662  * __set_agg_ports_ready - set value of Ready bit in all ports of an aggregator
663  * @aggregator: the aggregator we're looking at
664  * @val: Should the ports' ready bit be set on or off
665  *
666  */
667 static void __set_agg_ports_ready(struct aggregator *aggregator, int val)
668 {
669 	struct port *port;
670 
671 	for (port = aggregator->lag_ports; port;
672 	     port = port->next_port_in_aggregator) {
673 		if (val)
674 			port->sm_vars |= AD_PORT_READY;
675 		else
676 			port->sm_vars &= ~AD_PORT_READY;
677 	}
678 }
679 
680 static int __agg_active_ports(struct aggregator *agg)
681 {
682 	struct port *port;
683 	int active = 0;
684 
685 	for (port = agg->lag_ports; port;
686 	     port = port->next_port_in_aggregator) {
687 		if (port->is_enabled)
688 			active++;
689 	}
690 
691 	return active;
692 }
693 
694 /**
695  * __get_agg_bandwidth - get the total bandwidth of an aggregator
696  * @aggregator: the aggregator we're looking at
697  *
698  */
699 static u32 __get_agg_bandwidth(struct aggregator *aggregator)
700 {
701 	int nports = __agg_active_ports(aggregator);
702 	u32 bandwidth = 0;
703 
704 	if (nports) {
705 		switch (__get_link_speed(aggregator->lag_ports)) {
706 		case AD_LINK_SPEED_1MBPS:
707 			bandwidth = nports;
708 			break;
709 		case AD_LINK_SPEED_10MBPS:
710 			bandwidth = nports * 10;
711 			break;
712 		case AD_LINK_SPEED_100MBPS:
713 			bandwidth = nports * 100;
714 			break;
715 		case AD_LINK_SPEED_1000MBPS:
716 			bandwidth = nports * 1000;
717 			break;
718 		case AD_LINK_SPEED_2500MBPS:
719 			bandwidth = nports * 2500;
720 			break;
721 		case AD_LINK_SPEED_5000MBPS:
722 			bandwidth = nports * 5000;
723 			break;
724 		case AD_LINK_SPEED_10000MBPS:
725 			bandwidth = nports * 10000;
726 			break;
727 		case AD_LINK_SPEED_14000MBPS:
728 			bandwidth = nports * 14000;
729 			break;
730 		case AD_LINK_SPEED_20000MBPS:
731 			bandwidth = nports * 20000;
732 			break;
733 		case AD_LINK_SPEED_25000MBPS:
734 			bandwidth = nports * 25000;
735 			break;
736 		case AD_LINK_SPEED_40000MBPS:
737 			bandwidth = nports * 40000;
738 			break;
739 		case AD_LINK_SPEED_50000MBPS:
740 			bandwidth = nports * 50000;
741 			break;
742 		case AD_LINK_SPEED_56000MBPS:
743 			bandwidth = nports * 56000;
744 			break;
745 		case AD_LINK_SPEED_100000MBPS:
746 			bandwidth = nports * 100000;
747 			break;
748 		case AD_LINK_SPEED_200000MBPS:
749 			bandwidth = nports * 200000;
750 			break;
751 		case AD_LINK_SPEED_400000MBPS:
752 			bandwidth = nports * 400000;
753 			break;
754 		default:
755 			bandwidth = 0; /* to silence the compiler */
756 		}
757 	}
758 	return bandwidth;
759 }
760 
761 /**
762  * __get_active_agg - get the current active aggregator
763  * @aggregator: the aggregator we're looking at
764  *
765  * Caller must hold RCU lock.
766  */
767 static struct aggregator *__get_active_agg(struct aggregator *aggregator)
768 {
769 	struct bonding *bond = aggregator->slave->bond;
770 	struct list_head *iter;
771 	struct slave *slave;
772 
773 	bond_for_each_slave_rcu(bond, slave, iter)
774 		if (SLAVE_AD_INFO(slave)->aggregator.is_active)
775 			return &(SLAVE_AD_INFO(slave)->aggregator);
776 
777 	return NULL;
778 }
779 
780 /**
781  * __update_lacpdu_from_port - update a port's lacpdu fields
782  * @port: the port we're looking at
783  */
784 static inline void __update_lacpdu_from_port(struct port *port)
785 {
786 	struct lacpdu *lacpdu = &port->lacpdu;
787 	const struct port_params *partner = &port->partner_oper;
788 
789 	/* update current actual Actor parameters
790 	 * lacpdu->subtype                   initialized
791 	 * lacpdu->version_number            initialized
792 	 * lacpdu->tlv_type_actor_info       initialized
793 	 * lacpdu->actor_information_length  initialized
794 	 */
795 
796 	lacpdu->actor_system_priority = htons(port->actor_system_priority);
797 	lacpdu->actor_system = port->actor_system;
798 	lacpdu->actor_key = htons(port->actor_oper_port_key);
799 	lacpdu->actor_port_priority = htons(port->actor_port_priority);
800 	lacpdu->actor_port = htons(port->actor_port_number);
801 	lacpdu->actor_state = port->actor_oper_port_state;
802 	slave_dbg(port->slave->bond->dev, port->slave->dev,
803 		  "update lacpdu: actor port state %x\n",
804 		  port->actor_oper_port_state);
805 
806 	/* lacpdu->reserved_3_1              initialized
807 	 * lacpdu->tlv_type_partner_info     initialized
808 	 * lacpdu->partner_information_length initialized
809 	 */
810 
811 	lacpdu->partner_system_priority = htons(partner->system_priority);
812 	lacpdu->partner_system = partner->system;
813 	lacpdu->partner_key = htons(partner->key);
814 	lacpdu->partner_port_priority = htons(partner->port_priority);
815 	lacpdu->partner_port = htons(partner->port_number);
816 	lacpdu->partner_state = partner->port_state;
817 
818 	/* lacpdu->reserved_3_2              initialized
819 	 * lacpdu->tlv_type_collector_info   initialized
820 	 * lacpdu->collector_information_length initialized
821 	 * collector_max_delay                initialized
822 	 * reserved_12[12]                   initialized
823 	 * tlv_type_terminator               initialized
824 	 * terminator_length                 initialized
825 	 * reserved_50[50]                   initialized
826 	 */
827 }
828 
829 /* ================= main 802.3ad protocol code ========================= */
830 
831 /**
832  * ad_lacpdu_send - send out a lacpdu packet on a given port
833  * @port: the port we're looking at
834  *
835  * Returns:   0 on success
836  *          < 0 on error
837  */
838 static int ad_lacpdu_send(struct port *port)
839 {
840 	struct slave *slave = port->slave;
841 	struct sk_buff *skb;
842 	struct lacpdu_header *lacpdu_header;
843 	int length = sizeof(struct lacpdu_header);
844 
845 	skb = dev_alloc_skb(length);
846 	if (!skb)
847 		return -ENOMEM;
848 
849 	atomic64_inc(&SLAVE_AD_INFO(slave)->stats.lacpdu_tx);
850 	atomic64_inc(&BOND_AD_INFO(slave->bond).stats.lacpdu_tx);
851 
852 	skb->dev = slave->dev;
853 	skb_reset_mac_header(skb);
854 	skb->network_header = skb->mac_header + ETH_HLEN;
855 	skb->protocol = PKT_TYPE_LACPDU;
856 	skb->priority = TC_PRIO_CONTROL;
857 
858 	lacpdu_header = skb_put(skb, length);
859 
860 	ether_addr_copy(lacpdu_header->hdr.h_dest, lacpdu_mcast_addr);
861 	/* Note: source address is set to be the member's PERMANENT address,
862 	 * because we use it to identify loopback lacpdus in receive.
863 	 */
864 	ether_addr_copy(lacpdu_header->hdr.h_source, slave->perm_hwaddr);
865 	lacpdu_header->hdr.h_proto = PKT_TYPE_LACPDU;
866 
867 	lacpdu_header->lacpdu = port->lacpdu;
868 
869 	dev_queue_xmit(skb);
870 
871 	return 0;
872 }
873 
874 /**
875  * ad_marker_send - send marker information/response on a given port
876  * @port: the port we're looking at
877  * @marker: marker data to send
878  *
879  * Returns:   0 on success
880  *          < 0 on error
881  */
882 static int ad_marker_send(struct port *port, struct bond_marker *marker)
883 {
884 	struct slave *slave = port->slave;
885 	struct sk_buff *skb;
886 	struct bond_marker_header *marker_header;
887 	int length = sizeof(struct bond_marker_header);
888 
889 	skb = dev_alloc_skb(length + 16);
890 	if (!skb)
891 		return -ENOMEM;
892 
893 	switch (marker->tlv_type) {
894 	case AD_MARKER_INFORMATION_SUBTYPE:
895 		atomic64_inc(&SLAVE_AD_INFO(slave)->stats.marker_tx);
896 		atomic64_inc(&BOND_AD_INFO(slave->bond).stats.marker_tx);
897 		break;
898 	case AD_MARKER_RESPONSE_SUBTYPE:
899 		atomic64_inc(&SLAVE_AD_INFO(slave)->stats.marker_resp_tx);
900 		atomic64_inc(&BOND_AD_INFO(slave->bond).stats.marker_resp_tx);
901 		break;
902 	}
903 
904 	skb_reserve(skb, 16);
905 
906 	skb->dev = slave->dev;
907 	skb_reset_mac_header(skb);
908 	skb->network_header = skb->mac_header + ETH_HLEN;
909 	skb->protocol = PKT_TYPE_LACPDU;
910 
911 	marker_header = skb_put(skb, length);
912 
913 	ether_addr_copy(marker_header->hdr.h_dest, lacpdu_mcast_addr);
914 	/* Note: source address is set to be the member's PERMANENT address,
915 	 * because we use it to identify loopback MARKERs in receive.
916 	 */
917 	ether_addr_copy(marker_header->hdr.h_source, slave->perm_hwaddr);
918 	marker_header->hdr.h_proto = PKT_TYPE_LACPDU;
919 
920 	marker_header->marker = *marker;
921 
922 	dev_queue_xmit(skb);
923 
924 	return 0;
925 }
926 
927 /**
928  * ad_mux_machine - handle a port's mux state machine
929  * @port: the port we're looking at
930  * @update_slave_arr: Does slave array need update?
931  */
932 static void ad_mux_machine(struct port *port, bool *update_slave_arr)
933 {
934 	mux_states_t last_state;
935 
936 	/* keep current State Machine state to compare later if it was
937 	 * changed
938 	 */
939 	last_state = port->sm_mux_state;
940 
941 	if (port->sm_vars & AD_PORT_BEGIN) {
942 		port->sm_mux_state = AD_MUX_DETACHED;
943 	} else {
944 		switch (port->sm_mux_state) {
945 		case AD_MUX_DETACHED:
946 			if ((port->sm_vars & AD_PORT_SELECTED)
947 			    || (port->sm_vars & AD_PORT_STANDBY))
948 				/* if SELECTED or STANDBY */
949 				port->sm_mux_state = AD_MUX_WAITING;
950 			break;
951 		case AD_MUX_WAITING:
952 			/* if SELECTED == FALSE return to DETACH state */
953 			if (!(port->sm_vars & AD_PORT_SELECTED)) {
954 				port->sm_vars &= ~AD_PORT_READY_N;
955 				/* in order to withhold the Selection Logic to
956 				 * check all ports READY_N value every callback
957 				 * cycle to update ready variable, we check
958 				 * READY_N and update READY here
959 				 */
960 				__set_agg_ports_ready(port->aggregator, __agg_ports_are_ready(port->aggregator));
961 				port->sm_mux_state = AD_MUX_DETACHED;
962 				break;
963 			}
964 
965 			/* check if the wait_while_timer expired */
966 			if (port->sm_mux_timer_counter
967 			    && !(--port->sm_mux_timer_counter))
968 				port->sm_vars |= AD_PORT_READY_N;
969 
970 			/* in order to withhold the selection logic to check
971 			 * all ports READY_N value every callback cycle to
972 			 * update ready variable, we check READY_N and update
973 			 * READY here
974 			 */
975 			__set_agg_ports_ready(port->aggregator, __agg_ports_are_ready(port->aggregator));
976 
977 			/* if the wait_while_timer expired, and the port is
978 			 * in READY state, move to ATTACHED state
979 			 */
980 			if ((port->sm_vars & AD_PORT_READY)
981 			    && !port->sm_mux_timer_counter)
982 				port->sm_mux_state = AD_MUX_ATTACHED;
983 			break;
984 		case AD_MUX_ATTACHED:
985 			/* check also if agg_select_timer expired (so the
986 			 * edable port will take place only after this timer)
987 			 */
988 			if ((port->sm_vars & AD_PORT_SELECTED) &&
989 			    (port->partner_oper.port_state & LACP_STATE_SYNCHRONIZATION) &&
990 			    !__check_agg_selection_timer(port)) {
991 				if (port->aggregator->is_active)
992 					port->sm_mux_state =
993 					    AD_MUX_COLLECTING_DISTRIBUTING;
994 			} else if (!(port->sm_vars & AD_PORT_SELECTED) ||
995 				   (port->sm_vars & AD_PORT_STANDBY)) {
996 				/* if UNSELECTED or STANDBY */
997 				port->sm_vars &= ~AD_PORT_READY_N;
998 				/* in order to withhold the selection logic to
999 				 * check all ports READY_N value every callback
1000 				 * cycle to update ready variable, we check
1001 				 * READY_N and update READY here
1002 				 */
1003 				__set_agg_ports_ready(port->aggregator, __agg_ports_are_ready(port->aggregator));
1004 				port->sm_mux_state = AD_MUX_DETACHED;
1005 			} else if (port->aggregator->is_active) {
1006 				port->actor_oper_port_state |=
1007 				    LACP_STATE_SYNCHRONIZATION;
1008 			}
1009 			break;
1010 		case AD_MUX_COLLECTING_DISTRIBUTING:
1011 			if (!(port->sm_vars & AD_PORT_SELECTED) ||
1012 			    (port->sm_vars & AD_PORT_STANDBY) ||
1013 			    !(port->partner_oper.port_state & LACP_STATE_SYNCHRONIZATION) ||
1014 			    !(port->actor_oper_port_state & LACP_STATE_SYNCHRONIZATION)) {
1015 				port->sm_mux_state = AD_MUX_ATTACHED;
1016 			} else {
1017 				/* if port state hasn't changed make
1018 				 * sure that a collecting distributing
1019 				 * port in an active aggregator is enabled
1020 				 */
1021 				if (port->aggregator &&
1022 				    port->aggregator->is_active &&
1023 				    !__port_is_enabled(port)) {
1024 
1025 					__enable_port(port);
1026 				}
1027 			}
1028 			break;
1029 		default:
1030 			break;
1031 		}
1032 	}
1033 
1034 	/* check if the state machine was changed */
1035 	if (port->sm_mux_state != last_state) {
1036 		slave_dbg(port->slave->bond->dev, port->slave->dev,
1037 			  "Mux Machine: Port=%d, Last State=%d, Curr State=%d\n",
1038 			  port->actor_port_number,
1039 			  last_state,
1040 			  port->sm_mux_state);
1041 		switch (port->sm_mux_state) {
1042 		case AD_MUX_DETACHED:
1043 			port->actor_oper_port_state &= ~LACP_STATE_SYNCHRONIZATION;
1044 			ad_disable_collecting_distributing(port,
1045 							   update_slave_arr);
1046 			port->actor_oper_port_state &= ~LACP_STATE_COLLECTING;
1047 			port->actor_oper_port_state &= ~LACP_STATE_DISTRIBUTING;
1048 			port->ntt = true;
1049 			break;
1050 		case AD_MUX_WAITING:
1051 			port->sm_mux_timer_counter = __ad_timer_to_ticks(AD_WAIT_WHILE_TIMER, 0);
1052 			break;
1053 		case AD_MUX_ATTACHED:
1054 			if (port->aggregator->is_active)
1055 				port->actor_oper_port_state |=
1056 				    LACP_STATE_SYNCHRONIZATION;
1057 			else
1058 				port->actor_oper_port_state &=
1059 				    ~LACP_STATE_SYNCHRONIZATION;
1060 			port->actor_oper_port_state &= ~LACP_STATE_COLLECTING;
1061 			port->actor_oper_port_state &= ~LACP_STATE_DISTRIBUTING;
1062 			ad_disable_collecting_distributing(port,
1063 							   update_slave_arr);
1064 			port->ntt = true;
1065 			break;
1066 		case AD_MUX_COLLECTING_DISTRIBUTING:
1067 			port->actor_oper_port_state |= LACP_STATE_COLLECTING;
1068 			port->actor_oper_port_state |= LACP_STATE_DISTRIBUTING;
1069 			port->actor_oper_port_state |= LACP_STATE_SYNCHRONIZATION;
1070 			ad_enable_collecting_distributing(port,
1071 							  update_slave_arr);
1072 			port->ntt = true;
1073 			break;
1074 		default:
1075 			break;
1076 		}
1077 	}
1078 }
1079 
1080 /**
1081  * ad_rx_machine - handle a port's rx State Machine
1082  * @lacpdu: the lacpdu we've received
1083  * @port: the port we're looking at
1084  *
1085  * If lacpdu arrived, stop previous timer (if exists) and set the next state as
1086  * CURRENT. If timer expired set the state machine in the proper state.
1087  * In other cases, this function checks if we need to switch to other state.
1088  */
1089 static void ad_rx_machine(struct lacpdu *lacpdu, struct port *port)
1090 {
1091 	rx_states_t last_state;
1092 
1093 	/* keep current State Machine state to compare later if it was
1094 	 * changed
1095 	 */
1096 	last_state = port->sm_rx_state;
1097 
1098 	if (lacpdu) {
1099 		atomic64_inc(&SLAVE_AD_INFO(port->slave)->stats.lacpdu_rx);
1100 		atomic64_inc(&BOND_AD_INFO(port->slave->bond).stats.lacpdu_rx);
1101 	}
1102 	/* check if state machine should change state */
1103 
1104 	/* first, check if port was reinitialized */
1105 	if (port->sm_vars & AD_PORT_BEGIN) {
1106 		port->sm_rx_state = AD_RX_INITIALIZE;
1107 		port->sm_vars |= AD_PORT_CHURNED;
1108 	/* check if port is not enabled */
1109 	} else if (!(port->sm_vars & AD_PORT_BEGIN) && !port->is_enabled)
1110 		port->sm_rx_state = AD_RX_PORT_DISABLED;
1111 	/* check if new lacpdu arrived */
1112 	else if (lacpdu && ((port->sm_rx_state == AD_RX_EXPIRED) ||
1113 		 (port->sm_rx_state == AD_RX_DEFAULTED) ||
1114 		 (port->sm_rx_state == AD_RX_CURRENT))) {
1115 		if (port->sm_rx_state != AD_RX_CURRENT)
1116 			port->sm_vars |= AD_PORT_CHURNED;
1117 		port->sm_rx_timer_counter = 0;
1118 		port->sm_rx_state = AD_RX_CURRENT;
1119 	} else {
1120 		/* if timer is on, and if it is expired */
1121 		if (port->sm_rx_timer_counter &&
1122 		    !(--port->sm_rx_timer_counter)) {
1123 			switch (port->sm_rx_state) {
1124 			case AD_RX_EXPIRED:
1125 				port->sm_rx_state = AD_RX_DEFAULTED;
1126 				break;
1127 			case AD_RX_CURRENT:
1128 				port->sm_rx_state = AD_RX_EXPIRED;
1129 				break;
1130 			default:
1131 				break;
1132 			}
1133 		} else {
1134 			/* if no lacpdu arrived and no timer is on */
1135 			switch (port->sm_rx_state) {
1136 			case AD_RX_PORT_DISABLED:
1137 				if (port->is_enabled &&
1138 				    (port->sm_vars & AD_PORT_LACP_ENABLED))
1139 					port->sm_rx_state = AD_RX_EXPIRED;
1140 				else if (port->is_enabled
1141 					 && ((port->sm_vars
1142 					      & AD_PORT_LACP_ENABLED) == 0))
1143 					port->sm_rx_state = AD_RX_LACP_DISABLED;
1144 				break;
1145 			default:
1146 				break;
1147 
1148 			}
1149 		}
1150 	}
1151 
1152 	/* check if the State machine was changed or new lacpdu arrived */
1153 	if ((port->sm_rx_state != last_state) || (lacpdu)) {
1154 		slave_dbg(port->slave->bond->dev, port->slave->dev,
1155 			  "Rx Machine: Port=%d, Last State=%d, Curr State=%d\n",
1156 			  port->actor_port_number,
1157 			  last_state,
1158 			  port->sm_rx_state);
1159 		switch (port->sm_rx_state) {
1160 		case AD_RX_INITIALIZE:
1161 			if (!(port->actor_oper_port_key & AD_DUPLEX_KEY_MASKS))
1162 				port->sm_vars &= ~AD_PORT_LACP_ENABLED;
1163 			else
1164 				port->sm_vars |= AD_PORT_LACP_ENABLED;
1165 			port->sm_vars &= ~AD_PORT_SELECTED;
1166 			__record_default(port);
1167 			port->actor_oper_port_state &= ~LACP_STATE_EXPIRED;
1168 			port->sm_rx_state = AD_RX_PORT_DISABLED;
1169 
1170 			fallthrough;
1171 		case AD_RX_PORT_DISABLED:
1172 			port->sm_vars &= ~AD_PORT_MATCHED;
1173 			break;
1174 		case AD_RX_LACP_DISABLED:
1175 			port->sm_vars &= ~AD_PORT_SELECTED;
1176 			__record_default(port);
1177 			port->partner_oper.port_state &= ~LACP_STATE_AGGREGATION;
1178 			port->sm_vars |= AD_PORT_MATCHED;
1179 			port->actor_oper_port_state &= ~LACP_STATE_EXPIRED;
1180 			break;
1181 		case AD_RX_EXPIRED:
1182 			/* Reset of the Synchronization flag (Standard 43.4.12)
1183 			 * This reset cause to disable this port in the
1184 			 * COLLECTING_DISTRIBUTING state of the mux machine in
1185 			 * case of EXPIRED even if LINK_DOWN didn't arrive for
1186 			 * the port.
1187 			 */
1188 			port->partner_oper.port_state &= ~LACP_STATE_SYNCHRONIZATION;
1189 			port->sm_vars &= ~AD_PORT_MATCHED;
1190 			port->partner_oper.port_state |= LACP_STATE_LACP_TIMEOUT;
1191 			port->partner_oper.port_state |= LACP_STATE_LACP_ACTIVITY;
1192 			port->sm_rx_timer_counter = __ad_timer_to_ticks(AD_CURRENT_WHILE_TIMER, (u16)(AD_SHORT_TIMEOUT));
1193 			port->actor_oper_port_state |= LACP_STATE_EXPIRED;
1194 			port->sm_vars |= AD_PORT_CHURNED;
1195 			break;
1196 		case AD_RX_DEFAULTED:
1197 			__update_default_selected(port);
1198 			__record_default(port);
1199 			port->sm_vars |= AD_PORT_MATCHED;
1200 			port->actor_oper_port_state &= ~LACP_STATE_EXPIRED;
1201 			break;
1202 		case AD_RX_CURRENT:
1203 			/* detect loopback situation */
1204 			if (MAC_ADDRESS_EQUAL(&(lacpdu->actor_system),
1205 					      &(port->actor_system))) {
1206 				slave_err(port->slave->bond->dev, port->slave->dev, "An illegal loopback occurred on slave\n"
1207 					  "Check the configuration to verify that all adapters are connected to 802.3ad compliant switch ports\n");
1208 				return;
1209 			}
1210 			__update_selected(lacpdu, port);
1211 			__update_ntt(lacpdu, port);
1212 			__record_pdu(lacpdu, port);
1213 			port->sm_rx_timer_counter = __ad_timer_to_ticks(AD_CURRENT_WHILE_TIMER, (u16)(port->actor_oper_port_state & LACP_STATE_LACP_TIMEOUT));
1214 			port->actor_oper_port_state &= ~LACP_STATE_EXPIRED;
1215 			break;
1216 		default:
1217 			break;
1218 		}
1219 	}
1220 }
1221 
1222 /**
1223  * ad_churn_machine - handle port churn's state machine
1224  * @port: the port we're looking at
1225  *
1226  */
1227 static void ad_churn_machine(struct port *port)
1228 {
1229 	if (port->sm_vars & AD_PORT_CHURNED) {
1230 		port->sm_vars &= ~AD_PORT_CHURNED;
1231 		port->sm_churn_actor_state = AD_CHURN_MONITOR;
1232 		port->sm_churn_partner_state = AD_CHURN_MONITOR;
1233 		port->sm_churn_actor_timer_counter =
1234 			__ad_timer_to_ticks(AD_ACTOR_CHURN_TIMER, 0);
1235 		port->sm_churn_partner_timer_counter =
1236 			 __ad_timer_to_ticks(AD_PARTNER_CHURN_TIMER, 0);
1237 		return;
1238 	}
1239 	if (port->sm_churn_actor_timer_counter &&
1240 	    !(--port->sm_churn_actor_timer_counter) &&
1241 	    port->sm_churn_actor_state == AD_CHURN_MONITOR) {
1242 		if (port->actor_oper_port_state & LACP_STATE_SYNCHRONIZATION) {
1243 			port->sm_churn_actor_state = AD_NO_CHURN;
1244 		} else {
1245 			port->churn_actor_count++;
1246 			port->sm_churn_actor_state = AD_CHURN;
1247 		}
1248 	}
1249 	if (port->sm_churn_partner_timer_counter &&
1250 	    !(--port->sm_churn_partner_timer_counter) &&
1251 	    port->sm_churn_partner_state == AD_CHURN_MONITOR) {
1252 		if (port->partner_oper.port_state & LACP_STATE_SYNCHRONIZATION) {
1253 			port->sm_churn_partner_state = AD_NO_CHURN;
1254 		} else {
1255 			port->churn_partner_count++;
1256 			port->sm_churn_partner_state = AD_CHURN;
1257 		}
1258 	}
1259 }
1260 
1261 /**
1262  * ad_tx_machine - handle a port's tx state machine
1263  * @port: the port we're looking at
1264  */
1265 static void ad_tx_machine(struct port *port)
1266 {
1267 	/* check if tx timer expired, to verify that we do not send more than
1268 	 * 3 packets per second
1269 	 */
1270 	if (port->sm_tx_timer_counter && !(--port->sm_tx_timer_counter)) {
1271 		/* check if there is something to send */
1272 		if (port->ntt && (port->sm_vars & AD_PORT_LACP_ENABLED)) {
1273 			__update_lacpdu_from_port(port);
1274 
1275 			if (ad_lacpdu_send(port) >= 0) {
1276 				slave_dbg(port->slave->bond->dev,
1277 					  port->slave->dev,
1278 					  "Sent LACPDU on port %d\n",
1279 					  port->actor_port_number);
1280 
1281 				/* mark ntt as false, so it will not be sent
1282 				 * again until demanded
1283 				 */
1284 				port->ntt = false;
1285 			}
1286 		}
1287 		/* restart tx timer(to verify that we will not exceed
1288 		 * AD_MAX_TX_IN_SECOND
1289 		 */
1290 		port->sm_tx_timer_counter = ad_ticks_per_sec/AD_MAX_TX_IN_SECOND;
1291 	}
1292 }
1293 
1294 /**
1295  * ad_periodic_machine - handle a port's periodic state machine
1296  * @port: the port we're looking at
1297  *
1298  * Turn ntt flag on priodically to perform periodic transmission of lacpdu's.
1299  */
1300 static void ad_periodic_machine(struct port *port)
1301 {
1302 	periodic_states_t last_state;
1303 
1304 	/* keep current state machine state to compare later if it was changed */
1305 	last_state = port->sm_periodic_state;
1306 
1307 	/* check if port was reinitialized */
1308 	if (((port->sm_vars & AD_PORT_BEGIN) || !(port->sm_vars & AD_PORT_LACP_ENABLED) || !port->is_enabled) ||
1309 	    (!(port->actor_oper_port_state & LACP_STATE_LACP_ACTIVITY) && !(port->partner_oper.port_state & LACP_STATE_LACP_ACTIVITY))
1310 	   ) {
1311 		port->sm_periodic_state = AD_NO_PERIODIC;
1312 	}
1313 	/* check if state machine should change state */
1314 	else if (port->sm_periodic_timer_counter) {
1315 		/* check if periodic state machine expired */
1316 		if (!(--port->sm_periodic_timer_counter)) {
1317 			/* if expired then do tx */
1318 			port->sm_periodic_state = AD_PERIODIC_TX;
1319 		} else {
1320 			/* If not expired, check if there is some new timeout
1321 			 * parameter from the partner state
1322 			 */
1323 			switch (port->sm_periodic_state) {
1324 			case AD_FAST_PERIODIC:
1325 				if (!(port->partner_oper.port_state
1326 				      & LACP_STATE_LACP_TIMEOUT))
1327 					port->sm_periodic_state = AD_SLOW_PERIODIC;
1328 				break;
1329 			case AD_SLOW_PERIODIC:
1330 				if ((port->partner_oper.port_state & LACP_STATE_LACP_TIMEOUT)) {
1331 					port->sm_periodic_timer_counter = 0;
1332 					port->sm_periodic_state = AD_PERIODIC_TX;
1333 				}
1334 				break;
1335 			default:
1336 				break;
1337 			}
1338 		}
1339 	} else {
1340 		switch (port->sm_periodic_state) {
1341 		case AD_NO_PERIODIC:
1342 			port->sm_periodic_state = AD_FAST_PERIODIC;
1343 			break;
1344 		case AD_PERIODIC_TX:
1345 			if (!(port->partner_oper.port_state &
1346 			    LACP_STATE_LACP_TIMEOUT))
1347 				port->sm_periodic_state = AD_SLOW_PERIODIC;
1348 			else
1349 				port->sm_periodic_state = AD_FAST_PERIODIC;
1350 			break;
1351 		default:
1352 			break;
1353 		}
1354 	}
1355 
1356 	/* check if the state machine was changed */
1357 	if (port->sm_periodic_state != last_state) {
1358 		slave_dbg(port->slave->bond->dev, port->slave->dev,
1359 			  "Periodic Machine: Port=%d, Last State=%d, Curr State=%d\n",
1360 			  port->actor_port_number, last_state,
1361 			  port->sm_periodic_state);
1362 		switch (port->sm_periodic_state) {
1363 		case AD_NO_PERIODIC:
1364 			port->sm_periodic_timer_counter = 0;
1365 			break;
1366 		case AD_FAST_PERIODIC:
1367 			/* decrement 1 tick we lost in the PERIODIC_TX cycle */
1368 			port->sm_periodic_timer_counter = __ad_timer_to_ticks(AD_PERIODIC_TIMER, (u16)(AD_FAST_PERIODIC_TIME))-1;
1369 			break;
1370 		case AD_SLOW_PERIODIC:
1371 			/* decrement 1 tick we lost in the PERIODIC_TX cycle */
1372 			port->sm_periodic_timer_counter = __ad_timer_to_ticks(AD_PERIODIC_TIMER, (u16)(AD_SLOW_PERIODIC_TIME))-1;
1373 			break;
1374 		case AD_PERIODIC_TX:
1375 			port->ntt = true;
1376 			break;
1377 		default:
1378 			break;
1379 		}
1380 	}
1381 }
1382 
1383 /**
1384  * ad_port_selection_logic - select aggregation groups
1385  * @port: the port we're looking at
1386  * @update_slave_arr: Does slave array need update?
1387  *
1388  * Select aggregation groups, and assign each port for it's aggregetor. The
1389  * selection logic is called in the inititalization (after all the handshkes),
1390  * and after every lacpdu receive (if selected is off).
1391  */
1392 static void ad_port_selection_logic(struct port *port, bool *update_slave_arr)
1393 {
1394 	struct aggregator *aggregator, *free_aggregator = NULL, *temp_aggregator;
1395 	struct port *last_port = NULL, *curr_port;
1396 	struct list_head *iter;
1397 	struct bonding *bond;
1398 	struct slave *slave;
1399 	int found = 0;
1400 
1401 	/* if the port is already Selected, do nothing */
1402 	if (port->sm_vars & AD_PORT_SELECTED)
1403 		return;
1404 
1405 	bond = __get_bond_by_port(port);
1406 
1407 	/* if the port is connected to other aggregator, detach it */
1408 	if (port->aggregator) {
1409 		/* detach the port from its former aggregator */
1410 		temp_aggregator = port->aggregator;
1411 		for (curr_port = temp_aggregator->lag_ports; curr_port;
1412 		     last_port = curr_port,
1413 		     curr_port = curr_port->next_port_in_aggregator) {
1414 			if (curr_port == port) {
1415 				temp_aggregator->num_of_ports--;
1416 				/* if it is the first port attached to the
1417 				 * aggregator
1418 				 */
1419 				if (!last_port) {
1420 					temp_aggregator->lag_ports =
1421 						port->next_port_in_aggregator;
1422 				} else {
1423 					/* not the first port attached to the
1424 					 * aggregator
1425 					 */
1426 					last_port->next_port_in_aggregator =
1427 						port->next_port_in_aggregator;
1428 				}
1429 
1430 				/* clear the port's relations to this
1431 				 * aggregator
1432 				 */
1433 				port->aggregator = NULL;
1434 				port->next_port_in_aggregator = NULL;
1435 				port->actor_port_aggregator_identifier = 0;
1436 
1437 				slave_dbg(bond->dev, port->slave->dev, "Port %d left LAG %d\n",
1438 					  port->actor_port_number,
1439 					  temp_aggregator->aggregator_identifier);
1440 				/* if the aggregator is empty, clear its
1441 				 * parameters, and set it ready to be attached
1442 				 */
1443 				if (!temp_aggregator->lag_ports)
1444 					ad_clear_agg(temp_aggregator);
1445 				break;
1446 			}
1447 		}
1448 		if (!curr_port) {
1449 			/* meaning: the port was related to an aggregator
1450 			 * but was not on the aggregator port list
1451 			 */
1452 			net_warn_ratelimited("%s: (slave %s): Warning: Port %d was related to aggregator %d but was not on its port list\n",
1453 					     port->slave->bond->dev->name,
1454 					     port->slave->dev->name,
1455 					     port->actor_port_number,
1456 					     port->aggregator->aggregator_identifier);
1457 		}
1458 	}
1459 	/* search on all aggregators for a suitable aggregator for this port */
1460 	bond_for_each_slave(bond, slave, iter) {
1461 		aggregator = &(SLAVE_AD_INFO(slave)->aggregator);
1462 
1463 		/* keep a free aggregator for later use(if needed) */
1464 		if (!aggregator->lag_ports) {
1465 			if (!free_aggregator)
1466 				free_aggregator = aggregator;
1467 			continue;
1468 		}
1469 		/* check if current aggregator suits us */
1470 		if (((aggregator->actor_oper_aggregator_key == port->actor_oper_port_key) && /* if all parameters match AND */
1471 		     MAC_ADDRESS_EQUAL(&(aggregator->partner_system), &(port->partner_oper.system)) &&
1472 		     (aggregator->partner_system_priority == port->partner_oper.system_priority) &&
1473 		     (aggregator->partner_oper_aggregator_key == port->partner_oper.key)
1474 		    ) &&
1475 		    ((!MAC_ADDRESS_EQUAL(&(port->partner_oper.system), &(null_mac_addr)) && /* partner answers */
1476 		      !aggregator->is_individual)  /* but is not individual OR */
1477 		    )
1478 		   ) {
1479 			/* attach to the founded aggregator */
1480 			port->aggregator = aggregator;
1481 			port->actor_port_aggregator_identifier =
1482 				port->aggregator->aggregator_identifier;
1483 			port->next_port_in_aggregator = aggregator->lag_ports;
1484 			port->aggregator->num_of_ports++;
1485 			aggregator->lag_ports = port;
1486 			slave_dbg(bond->dev, slave->dev, "Port %d joined LAG %d (existing LAG)\n",
1487 				  port->actor_port_number,
1488 				  port->aggregator->aggregator_identifier);
1489 
1490 			/* mark this port as selected */
1491 			port->sm_vars |= AD_PORT_SELECTED;
1492 			found = 1;
1493 			break;
1494 		}
1495 	}
1496 
1497 	/* the port couldn't find an aggregator - attach it to a new
1498 	 * aggregator
1499 	 */
1500 	if (!found) {
1501 		if (free_aggregator) {
1502 			/* assign port a new aggregator */
1503 			port->aggregator = free_aggregator;
1504 			port->actor_port_aggregator_identifier =
1505 				port->aggregator->aggregator_identifier;
1506 
1507 			/* update the new aggregator's parameters
1508 			 * if port was responsed from the end-user
1509 			 */
1510 			if (port->actor_oper_port_key & AD_DUPLEX_KEY_MASKS)
1511 				/* if port is full duplex */
1512 				port->aggregator->is_individual = false;
1513 			else
1514 				port->aggregator->is_individual = true;
1515 
1516 			port->aggregator->actor_admin_aggregator_key =
1517 				port->actor_admin_port_key;
1518 			port->aggregator->actor_oper_aggregator_key =
1519 				port->actor_oper_port_key;
1520 			port->aggregator->partner_system =
1521 				port->partner_oper.system;
1522 			port->aggregator->partner_system_priority =
1523 				port->partner_oper.system_priority;
1524 			port->aggregator->partner_oper_aggregator_key = port->partner_oper.key;
1525 			port->aggregator->receive_state = 1;
1526 			port->aggregator->transmit_state = 1;
1527 			port->aggregator->lag_ports = port;
1528 			port->aggregator->num_of_ports++;
1529 
1530 			/* mark this port as selected */
1531 			port->sm_vars |= AD_PORT_SELECTED;
1532 
1533 			slave_dbg(bond->dev, port->slave->dev, "Port %d joined LAG %d (new LAG)\n",
1534 				  port->actor_port_number,
1535 				  port->aggregator->aggregator_identifier);
1536 		} else {
1537 			slave_err(bond->dev, port->slave->dev,
1538 				  "Port %d did not find a suitable aggregator\n",
1539 				  port->actor_port_number);
1540 		}
1541 	}
1542 	/* if all aggregator's ports are READY_N == TRUE, set ready=TRUE
1543 	 * in all aggregator's ports, else set ready=FALSE in all
1544 	 * aggregator's ports
1545 	 */
1546 	__set_agg_ports_ready(port->aggregator,
1547 			      __agg_ports_are_ready(port->aggregator));
1548 
1549 	aggregator = __get_first_agg(port);
1550 	ad_agg_selection_logic(aggregator, update_slave_arr);
1551 
1552 	if (!port->aggregator->is_active)
1553 		port->actor_oper_port_state &= ~LACP_STATE_SYNCHRONIZATION;
1554 }
1555 
1556 /* Decide if "agg" is a better choice for the new active aggregator that
1557  * the current best, according to the ad_select policy.
1558  */
1559 static struct aggregator *ad_agg_selection_test(struct aggregator *best,
1560 						struct aggregator *curr)
1561 {
1562 	/* 0. If no best, select current.
1563 	 *
1564 	 * 1. If the current agg is not individual, and the best is
1565 	 *    individual, select current.
1566 	 *
1567 	 * 2. If current agg is individual and the best is not, keep best.
1568 	 *
1569 	 * 3. Therefore, current and best are both individual or both not
1570 	 *    individual, so:
1571 	 *
1572 	 * 3a. If current agg partner replied, and best agg partner did not,
1573 	 *     select current.
1574 	 *
1575 	 * 3b. If current agg partner did not reply and best agg partner
1576 	 *     did reply, keep best.
1577 	 *
1578 	 * 4.  Therefore, current and best both have partner replies or
1579 	 *     both do not, so perform selection policy:
1580 	 *
1581 	 * BOND_AD_COUNT: Select by count of ports.  If count is equal,
1582 	 *     select by bandwidth.
1583 	 *
1584 	 * BOND_AD_STABLE, BOND_AD_BANDWIDTH: Select by bandwidth.
1585 	 */
1586 	if (!best)
1587 		return curr;
1588 
1589 	if (!curr->is_individual && best->is_individual)
1590 		return curr;
1591 
1592 	if (curr->is_individual && !best->is_individual)
1593 		return best;
1594 
1595 	if (__agg_has_partner(curr) && !__agg_has_partner(best))
1596 		return curr;
1597 
1598 	if (!__agg_has_partner(curr) && __agg_has_partner(best))
1599 		return best;
1600 
1601 	switch (__get_agg_selection_mode(curr->lag_ports)) {
1602 	case BOND_AD_COUNT:
1603 		if (__agg_active_ports(curr) > __agg_active_ports(best))
1604 			return curr;
1605 
1606 		if (__agg_active_ports(curr) < __agg_active_ports(best))
1607 			return best;
1608 
1609 		fallthrough;
1610 	case BOND_AD_STABLE:
1611 	case BOND_AD_BANDWIDTH:
1612 		if (__get_agg_bandwidth(curr) > __get_agg_bandwidth(best))
1613 			return curr;
1614 
1615 		break;
1616 
1617 	default:
1618 		net_warn_ratelimited("%s: (slave %s): Impossible agg select mode %d\n",
1619 				     curr->slave->bond->dev->name,
1620 				     curr->slave->dev->name,
1621 				     __get_agg_selection_mode(curr->lag_ports));
1622 		break;
1623 	}
1624 
1625 	return best;
1626 }
1627 
1628 static int agg_device_up(const struct aggregator *agg)
1629 {
1630 	struct port *port = agg->lag_ports;
1631 
1632 	if (!port)
1633 		return 0;
1634 
1635 	for (port = agg->lag_ports; port;
1636 	     port = port->next_port_in_aggregator) {
1637 		if (netif_running(port->slave->dev) &&
1638 		    netif_carrier_ok(port->slave->dev))
1639 			return 1;
1640 	}
1641 
1642 	return 0;
1643 }
1644 
1645 /**
1646  * ad_agg_selection_logic - select an aggregation group for a team
1647  * @agg: the aggregator we're looking at
1648  * @update_slave_arr: Does slave array need update?
1649  *
1650  * It is assumed that only one aggregator may be selected for a team.
1651  *
1652  * The logic of this function is to select the aggregator according to
1653  * the ad_select policy:
1654  *
1655  * BOND_AD_STABLE: select the aggregator with the most ports attached to
1656  * it, and to reselect the active aggregator only if the previous
1657  * aggregator has no more ports related to it.
1658  *
1659  * BOND_AD_BANDWIDTH: select the aggregator with the highest total
1660  * bandwidth, and reselect whenever a link state change takes place or the
1661  * set of slaves in the bond changes.
1662  *
1663  * BOND_AD_COUNT: select the aggregator with largest number of ports
1664  * (slaves), and reselect whenever a link state change takes place or the
1665  * set of slaves in the bond changes.
1666  *
1667  * FIXME: this function MUST be called with the first agg in the bond, or
1668  * __get_active_agg() won't work correctly. This function should be better
1669  * called with the bond itself, and retrieve the first agg from it.
1670  */
1671 static void ad_agg_selection_logic(struct aggregator *agg,
1672 				   bool *update_slave_arr)
1673 {
1674 	struct aggregator *best, *active, *origin;
1675 	struct bonding *bond = agg->slave->bond;
1676 	struct list_head *iter;
1677 	struct slave *slave;
1678 	struct port *port;
1679 
1680 	rcu_read_lock();
1681 	origin = agg;
1682 	active = __get_active_agg(agg);
1683 	best = (active && agg_device_up(active)) ? active : NULL;
1684 
1685 	bond_for_each_slave_rcu(bond, slave, iter) {
1686 		agg = &(SLAVE_AD_INFO(slave)->aggregator);
1687 
1688 		agg->is_active = 0;
1689 
1690 		if (__agg_active_ports(agg) && agg_device_up(agg))
1691 			best = ad_agg_selection_test(best, agg);
1692 	}
1693 
1694 	if (best &&
1695 	    __get_agg_selection_mode(best->lag_ports) == BOND_AD_STABLE) {
1696 		/* For the STABLE policy, don't replace the old active
1697 		 * aggregator if it's still active (it has an answering
1698 		 * partner) or if both the best and active don't have an
1699 		 * answering partner.
1700 		 */
1701 		if (active && active->lag_ports &&
1702 		    __agg_active_ports(active) &&
1703 		    (__agg_has_partner(active) ||
1704 		     (!__agg_has_partner(active) &&
1705 		     !__agg_has_partner(best)))) {
1706 			if (!(!active->actor_oper_aggregator_key &&
1707 			      best->actor_oper_aggregator_key)) {
1708 				best = NULL;
1709 				active->is_active = 1;
1710 			}
1711 		}
1712 	}
1713 
1714 	if (best && (best == active)) {
1715 		best = NULL;
1716 		active->is_active = 1;
1717 	}
1718 
1719 	/* if there is new best aggregator, activate it */
1720 	if (best) {
1721 		netdev_dbg(bond->dev, "(slave %s): best Agg=%d; P=%d; a k=%d; p k=%d; Ind=%d; Act=%d\n",
1722 			   best->slave ? best->slave->dev->name : "NULL",
1723 			   best->aggregator_identifier, best->num_of_ports,
1724 			   best->actor_oper_aggregator_key,
1725 			   best->partner_oper_aggregator_key,
1726 			   best->is_individual, best->is_active);
1727 		netdev_dbg(bond->dev, "(slave %s): best ports %p slave %p\n",
1728 			   best->slave ? best->slave->dev->name : "NULL",
1729 			   best->lag_ports, best->slave);
1730 
1731 		bond_for_each_slave_rcu(bond, slave, iter) {
1732 			agg = &(SLAVE_AD_INFO(slave)->aggregator);
1733 
1734 			slave_dbg(bond->dev, slave->dev, "Agg=%d; P=%d; a k=%d; p k=%d; Ind=%d; Act=%d\n",
1735 				  agg->aggregator_identifier, agg->num_of_ports,
1736 				  agg->actor_oper_aggregator_key,
1737 				  agg->partner_oper_aggregator_key,
1738 				  agg->is_individual, agg->is_active);
1739 		}
1740 
1741 		/* check if any partner replies */
1742 		if (best->is_individual)
1743 			net_warn_ratelimited("%s: Warning: No 802.3ad response from the link partner for any adapters in the bond\n",
1744 					     bond->dev->name);
1745 
1746 		best->is_active = 1;
1747 		netdev_dbg(bond->dev, "(slave %s): LAG %d chosen as the active LAG\n",
1748 			   best->slave ? best->slave->dev->name : "NULL",
1749 			   best->aggregator_identifier);
1750 		netdev_dbg(bond->dev, "(slave %s): Agg=%d; P=%d; a k=%d; p k=%d; Ind=%d; Act=%d\n",
1751 			   best->slave ? best->slave->dev->name : "NULL",
1752 			   best->aggregator_identifier, best->num_of_ports,
1753 			   best->actor_oper_aggregator_key,
1754 			   best->partner_oper_aggregator_key,
1755 			   best->is_individual, best->is_active);
1756 
1757 		/* disable the ports that were related to the former
1758 		 * active_aggregator
1759 		 */
1760 		if (active) {
1761 			for (port = active->lag_ports; port;
1762 			     port = port->next_port_in_aggregator) {
1763 				__disable_port(port);
1764 			}
1765 		}
1766 		/* Slave array needs update. */
1767 		*update_slave_arr = true;
1768 	}
1769 
1770 	/* if the selected aggregator is of join individuals
1771 	 * (partner_system is NULL), enable their ports
1772 	 */
1773 	active = __get_active_agg(origin);
1774 
1775 	if (active) {
1776 		if (!__agg_has_partner(active)) {
1777 			for (port = active->lag_ports; port;
1778 			     port = port->next_port_in_aggregator) {
1779 				__enable_port(port);
1780 			}
1781 		}
1782 	}
1783 
1784 	rcu_read_unlock();
1785 
1786 	bond_3ad_set_carrier(bond);
1787 }
1788 
1789 /**
1790  * ad_clear_agg - clear a given aggregator's parameters
1791  * @aggregator: the aggregator we're looking at
1792  */
1793 static void ad_clear_agg(struct aggregator *aggregator)
1794 {
1795 	if (aggregator) {
1796 		aggregator->is_individual = false;
1797 		aggregator->actor_admin_aggregator_key = 0;
1798 		aggregator->actor_oper_aggregator_key = 0;
1799 		eth_zero_addr(aggregator->partner_system.mac_addr_value);
1800 		aggregator->partner_system_priority = 0;
1801 		aggregator->partner_oper_aggregator_key = 0;
1802 		aggregator->receive_state = 0;
1803 		aggregator->transmit_state = 0;
1804 		aggregator->lag_ports = NULL;
1805 		aggregator->is_active = 0;
1806 		aggregator->num_of_ports = 0;
1807 		pr_debug("%s: LAG %d was cleared\n",
1808 			 aggregator->slave ?
1809 			 aggregator->slave->dev->name : "NULL",
1810 			 aggregator->aggregator_identifier);
1811 	}
1812 }
1813 
1814 /**
1815  * ad_initialize_agg - initialize a given aggregator's parameters
1816  * @aggregator: the aggregator we're looking at
1817  */
1818 static void ad_initialize_agg(struct aggregator *aggregator)
1819 {
1820 	if (aggregator) {
1821 		ad_clear_agg(aggregator);
1822 
1823 		eth_zero_addr(aggregator->aggregator_mac_address.mac_addr_value);
1824 		aggregator->aggregator_identifier = 0;
1825 		aggregator->slave = NULL;
1826 	}
1827 }
1828 
1829 /**
1830  * ad_initialize_port - initialize a given port's parameters
1831  * @port: the port we're looking at
1832  * @lacp_fast: boolean. whether fast periodic should be used
1833  */
1834 static void ad_initialize_port(struct port *port, int lacp_fast)
1835 {
1836 	static const struct port_params tmpl = {
1837 		.system_priority = 0xffff,
1838 		.key             = 1,
1839 		.port_number     = 1,
1840 		.port_priority   = 0xff,
1841 		.port_state      = 1,
1842 	};
1843 	static const struct lacpdu lacpdu = {
1844 		.subtype		= 0x01,
1845 		.version_number = 0x01,
1846 		.tlv_type_actor_info = 0x01,
1847 		.actor_information_length = 0x14,
1848 		.tlv_type_partner_info = 0x02,
1849 		.partner_information_length = 0x14,
1850 		.tlv_type_collector_info = 0x03,
1851 		.collector_information_length = 0x10,
1852 		.collector_max_delay = htons(AD_COLLECTOR_MAX_DELAY),
1853 	};
1854 
1855 	if (port) {
1856 		port->actor_port_priority = 0xff;
1857 		port->actor_port_aggregator_identifier = 0;
1858 		port->ntt = false;
1859 		port->actor_admin_port_state = LACP_STATE_AGGREGATION |
1860 					       LACP_STATE_LACP_ACTIVITY;
1861 		port->actor_oper_port_state  = LACP_STATE_AGGREGATION |
1862 					       LACP_STATE_LACP_ACTIVITY;
1863 
1864 		if (lacp_fast)
1865 			port->actor_oper_port_state |= LACP_STATE_LACP_TIMEOUT;
1866 
1867 		memcpy(&port->partner_admin, &tmpl, sizeof(tmpl));
1868 		memcpy(&port->partner_oper, &tmpl, sizeof(tmpl));
1869 
1870 		port->is_enabled = true;
1871 		/* private parameters */
1872 		port->sm_vars = AD_PORT_BEGIN | AD_PORT_LACP_ENABLED;
1873 		port->sm_rx_state = 0;
1874 		port->sm_rx_timer_counter = 0;
1875 		port->sm_periodic_state = 0;
1876 		port->sm_periodic_timer_counter = 0;
1877 		port->sm_mux_state = 0;
1878 		port->sm_mux_timer_counter = 0;
1879 		port->sm_tx_state = 0;
1880 		port->aggregator = NULL;
1881 		port->next_port_in_aggregator = NULL;
1882 		port->transaction_id = 0;
1883 
1884 		port->sm_churn_actor_timer_counter = 0;
1885 		port->sm_churn_actor_state = 0;
1886 		port->churn_actor_count = 0;
1887 		port->sm_churn_partner_timer_counter = 0;
1888 		port->sm_churn_partner_state = 0;
1889 		port->churn_partner_count = 0;
1890 
1891 		memcpy(&port->lacpdu, &lacpdu, sizeof(lacpdu));
1892 	}
1893 }
1894 
1895 /**
1896  * ad_enable_collecting_distributing - enable a port's transmit/receive
1897  * @port: the port we're looking at
1898  * @update_slave_arr: Does slave array need update?
1899  *
1900  * Enable @port if it's in an active aggregator
1901  */
1902 static void ad_enable_collecting_distributing(struct port *port,
1903 					      bool *update_slave_arr)
1904 {
1905 	if (port->aggregator->is_active) {
1906 		slave_dbg(port->slave->bond->dev, port->slave->dev,
1907 			  "Enabling port %d (LAG %d)\n",
1908 			  port->actor_port_number,
1909 			  port->aggregator->aggregator_identifier);
1910 		__enable_port(port);
1911 		/* Slave array needs update */
1912 		*update_slave_arr = true;
1913 	}
1914 }
1915 
1916 /**
1917  * ad_disable_collecting_distributing - disable a port's transmit/receive
1918  * @port: the port we're looking at
1919  * @update_slave_arr: Does slave array need update?
1920  */
1921 static void ad_disable_collecting_distributing(struct port *port,
1922 					       bool *update_slave_arr)
1923 {
1924 	if (port->aggregator &&
1925 	    !MAC_ADDRESS_EQUAL(&(port->aggregator->partner_system),
1926 			       &(null_mac_addr))) {
1927 		slave_dbg(port->slave->bond->dev, port->slave->dev,
1928 			  "Disabling port %d (LAG %d)\n",
1929 			  port->actor_port_number,
1930 			  port->aggregator->aggregator_identifier);
1931 		__disable_port(port);
1932 		/* Slave array needs an update */
1933 		*update_slave_arr = true;
1934 	}
1935 }
1936 
1937 /**
1938  * ad_marker_info_received - handle receive of a Marker information frame
1939  * @marker_info: Marker info received
1940  * @port: the port we're looking at
1941  */
1942 static void ad_marker_info_received(struct bond_marker *marker_info,
1943 				    struct port *port)
1944 {
1945 	struct bond_marker marker;
1946 
1947 	atomic64_inc(&SLAVE_AD_INFO(port->slave)->stats.marker_rx);
1948 	atomic64_inc(&BOND_AD_INFO(port->slave->bond).stats.marker_rx);
1949 
1950 	/* copy the received marker data to the response marker */
1951 	memcpy(&marker, marker_info, sizeof(struct bond_marker));
1952 	/* change the marker subtype to marker response */
1953 	marker.tlv_type = AD_MARKER_RESPONSE_SUBTYPE;
1954 
1955 	/* send the marker response */
1956 	if (ad_marker_send(port, &marker) >= 0)
1957 		slave_dbg(port->slave->bond->dev, port->slave->dev,
1958 			  "Sent Marker Response on port %d\n",
1959 			  port->actor_port_number);
1960 }
1961 
1962 /**
1963  * ad_marker_response_received - handle receive of a marker response frame
1964  * @marker: marker PDU received
1965  * @port: the port we're looking at
1966  *
1967  * This function does nothing since we decided not to implement send and handle
1968  * response for marker PDU's, in this stage, but only to respond to marker
1969  * information.
1970  */
1971 static void ad_marker_response_received(struct bond_marker *marker,
1972 					struct port *port)
1973 {
1974 	atomic64_inc(&SLAVE_AD_INFO(port->slave)->stats.marker_resp_rx);
1975 	atomic64_inc(&BOND_AD_INFO(port->slave->bond).stats.marker_resp_rx);
1976 
1977 	/* DO NOTHING, SINCE WE DECIDED NOT TO IMPLEMENT THIS FEATURE FOR NOW */
1978 }
1979 
1980 /* ========= AD exported functions to the main bonding code ========= */
1981 
1982 /* Check aggregators status in team every T seconds */
1983 #define AD_AGGREGATOR_SELECTION_TIMER  8
1984 
1985 /**
1986  * bond_3ad_initiate_agg_selection - initate aggregator selection
1987  * @bond: bonding struct
1988  * @timeout: timeout value to set
1989  *
1990  * Set the aggregation selection timer, to initiate an agg selection in
1991  * the very near future.  Called during first initialization, and during
1992  * any down to up transitions of the bond.
1993  */
1994 void bond_3ad_initiate_agg_selection(struct bonding *bond, int timeout)
1995 {
1996 	BOND_AD_INFO(bond).agg_select_timer = timeout;
1997 }
1998 
1999 /**
2000  * bond_3ad_initialize - initialize a bond's 802.3ad parameters and structures
2001  * @bond: bonding struct to work on
2002  * @tick_resolution: tick duration (millisecond resolution)
2003  *
2004  * Can be called only after the mac address of the bond is set.
2005  */
2006 void bond_3ad_initialize(struct bonding *bond, u16 tick_resolution)
2007 {
2008 	/* check that the bond is not initialized yet */
2009 	if (!MAC_ADDRESS_EQUAL(&(BOND_AD_INFO(bond).system.sys_mac_addr),
2010 				bond->dev->dev_addr)) {
2011 
2012 		BOND_AD_INFO(bond).aggregator_identifier = 0;
2013 
2014 		BOND_AD_INFO(bond).system.sys_priority =
2015 			bond->params.ad_actor_sys_prio;
2016 		if (is_zero_ether_addr(bond->params.ad_actor_system))
2017 			BOND_AD_INFO(bond).system.sys_mac_addr =
2018 			    *((struct mac_addr *)bond->dev->dev_addr);
2019 		else
2020 			BOND_AD_INFO(bond).system.sys_mac_addr =
2021 			    *((struct mac_addr *)bond->params.ad_actor_system);
2022 
2023 		/* initialize how many times this module is called in one
2024 		 * second (should be about every 100ms)
2025 		 */
2026 		ad_ticks_per_sec = tick_resolution;
2027 
2028 		bond_3ad_initiate_agg_selection(bond,
2029 						AD_AGGREGATOR_SELECTION_TIMER *
2030 						ad_ticks_per_sec);
2031 	}
2032 }
2033 
2034 /**
2035  * bond_3ad_bind_slave - initialize a slave's port
2036  * @slave: slave struct to work on
2037  *
2038  * Returns:   0 on success
2039  *          < 0 on error
2040  */
2041 void bond_3ad_bind_slave(struct slave *slave)
2042 {
2043 	struct bonding *bond = bond_get_bond_by_slave(slave);
2044 	struct port *port;
2045 	struct aggregator *aggregator;
2046 
2047 	/* check that the slave has not been initialized yet. */
2048 	if (SLAVE_AD_INFO(slave)->port.slave != slave) {
2049 
2050 		/* port initialization */
2051 		port = &(SLAVE_AD_INFO(slave)->port);
2052 
2053 		ad_initialize_port(port, bond->params.lacp_fast);
2054 
2055 		port->slave = slave;
2056 		port->actor_port_number = SLAVE_AD_INFO(slave)->id;
2057 		/* key is determined according to the link speed, duplex and
2058 		 * user key
2059 		 */
2060 		port->actor_admin_port_key = bond->params.ad_user_port_key << 6;
2061 		ad_update_actor_keys(port, false);
2062 		/* actor system is the bond's system */
2063 		__ad_actor_update_port(port);
2064 		/* tx timer(to verify that no more than MAX_TX_IN_SECOND
2065 		 * lacpdu's are sent in one second)
2066 		 */
2067 		port->sm_tx_timer_counter = ad_ticks_per_sec/AD_MAX_TX_IN_SECOND;
2068 
2069 		__disable_port(port);
2070 
2071 		/* aggregator initialization */
2072 		aggregator = &(SLAVE_AD_INFO(slave)->aggregator);
2073 
2074 		ad_initialize_agg(aggregator);
2075 
2076 		aggregator->aggregator_mac_address = *((struct mac_addr *)bond->dev->dev_addr);
2077 		aggregator->aggregator_identifier = ++BOND_AD_INFO(bond).aggregator_identifier;
2078 		aggregator->slave = slave;
2079 		aggregator->is_active = 0;
2080 		aggregator->num_of_ports = 0;
2081 	}
2082 }
2083 
2084 /**
2085  * bond_3ad_unbind_slave - deinitialize a slave's port
2086  * @slave: slave struct to work on
2087  *
2088  * Search for the aggregator that is related to this port, remove the
2089  * aggregator and assign another aggregator for other port related to it
2090  * (if any), and remove the port.
2091  */
2092 void bond_3ad_unbind_slave(struct slave *slave)
2093 {
2094 	struct port *port, *prev_port, *temp_port;
2095 	struct aggregator *aggregator, *new_aggregator, *temp_aggregator;
2096 	int select_new_active_agg = 0;
2097 	struct bonding *bond = slave->bond;
2098 	struct slave *slave_iter;
2099 	struct list_head *iter;
2100 	bool dummy_slave_update; /* Ignore this value as caller updates array */
2101 
2102 	/* Sync against bond_3ad_state_machine_handler() */
2103 	spin_lock_bh(&bond->mode_lock);
2104 	aggregator = &(SLAVE_AD_INFO(slave)->aggregator);
2105 	port = &(SLAVE_AD_INFO(slave)->port);
2106 
2107 	/* if slave is null, the whole port is not initialized */
2108 	if (!port->slave) {
2109 		slave_warn(bond->dev, slave->dev, "Trying to unbind an uninitialized port\n");
2110 		goto out;
2111 	}
2112 
2113 	slave_dbg(bond->dev, slave->dev, "Unbinding Link Aggregation Group %d\n",
2114 		  aggregator->aggregator_identifier);
2115 
2116 	/* Tell the partner that this port is not suitable for aggregation */
2117 	port->actor_oper_port_state &= ~LACP_STATE_SYNCHRONIZATION;
2118 	port->actor_oper_port_state &= ~LACP_STATE_COLLECTING;
2119 	port->actor_oper_port_state &= ~LACP_STATE_DISTRIBUTING;
2120 	port->actor_oper_port_state &= ~LACP_STATE_AGGREGATION;
2121 	__update_lacpdu_from_port(port);
2122 	ad_lacpdu_send(port);
2123 
2124 	/* check if this aggregator is occupied */
2125 	if (aggregator->lag_ports) {
2126 		/* check if there are other ports related to this aggregator
2127 		 * except the port related to this slave(thats ensure us that
2128 		 * there is a reason to search for new aggregator, and that we
2129 		 * will find one
2130 		 */
2131 		if ((aggregator->lag_ports != port) ||
2132 		    (aggregator->lag_ports->next_port_in_aggregator)) {
2133 			/* find new aggregator for the related port(s) */
2134 			bond_for_each_slave(bond, slave_iter, iter) {
2135 				new_aggregator = &(SLAVE_AD_INFO(slave_iter)->aggregator);
2136 				/* if the new aggregator is empty, or it is
2137 				 * connected to our port only
2138 				 */
2139 				if (!new_aggregator->lag_ports ||
2140 				    ((new_aggregator->lag_ports == port) &&
2141 				     !new_aggregator->lag_ports->next_port_in_aggregator))
2142 					break;
2143 			}
2144 			if (!slave_iter)
2145 				new_aggregator = NULL;
2146 
2147 			/* if new aggregator found, copy the aggregator's
2148 			 * parameters and connect the related lag_ports to the
2149 			 * new aggregator
2150 			 */
2151 			if ((new_aggregator) && ((!new_aggregator->lag_ports) || ((new_aggregator->lag_ports == port) && !new_aggregator->lag_ports->next_port_in_aggregator))) {
2152 				slave_dbg(bond->dev, slave->dev, "Some port(s) related to LAG %d - replacing with LAG %d\n",
2153 					  aggregator->aggregator_identifier,
2154 					  new_aggregator->aggregator_identifier);
2155 
2156 				if ((new_aggregator->lag_ports == port) &&
2157 				    new_aggregator->is_active) {
2158 					slave_info(bond->dev, slave->dev, "Removing an active aggregator\n");
2159 					select_new_active_agg = 1;
2160 				}
2161 
2162 				new_aggregator->is_individual = aggregator->is_individual;
2163 				new_aggregator->actor_admin_aggregator_key = aggregator->actor_admin_aggregator_key;
2164 				new_aggregator->actor_oper_aggregator_key = aggregator->actor_oper_aggregator_key;
2165 				new_aggregator->partner_system = aggregator->partner_system;
2166 				new_aggregator->partner_system_priority = aggregator->partner_system_priority;
2167 				new_aggregator->partner_oper_aggregator_key = aggregator->partner_oper_aggregator_key;
2168 				new_aggregator->receive_state = aggregator->receive_state;
2169 				new_aggregator->transmit_state = aggregator->transmit_state;
2170 				new_aggregator->lag_ports = aggregator->lag_ports;
2171 				new_aggregator->is_active = aggregator->is_active;
2172 				new_aggregator->num_of_ports = aggregator->num_of_ports;
2173 
2174 				/* update the information that is written on
2175 				 * the ports about the aggregator
2176 				 */
2177 				for (temp_port = aggregator->lag_ports; temp_port;
2178 				     temp_port = temp_port->next_port_in_aggregator) {
2179 					temp_port->aggregator = new_aggregator;
2180 					temp_port->actor_port_aggregator_identifier = new_aggregator->aggregator_identifier;
2181 				}
2182 
2183 				ad_clear_agg(aggregator);
2184 
2185 				if (select_new_active_agg)
2186 					ad_agg_selection_logic(__get_first_agg(port),
2187 							       &dummy_slave_update);
2188 			} else {
2189 				slave_warn(bond->dev, slave->dev, "unbinding aggregator, and could not find a new aggregator for its ports\n");
2190 			}
2191 		} else {
2192 			/* in case that the only port related to this
2193 			 * aggregator is the one we want to remove
2194 			 */
2195 			select_new_active_agg = aggregator->is_active;
2196 			ad_clear_agg(aggregator);
2197 			if (select_new_active_agg) {
2198 				slave_info(bond->dev, slave->dev, "Removing an active aggregator\n");
2199 				/* select new active aggregator */
2200 				temp_aggregator = __get_first_agg(port);
2201 				if (temp_aggregator)
2202 					ad_agg_selection_logic(temp_aggregator,
2203 							       &dummy_slave_update);
2204 			}
2205 		}
2206 	}
2207 
2208 	slave_dbg(bond->dev, slave->dev, "Unbinding port %d\n", port->actor_port_number);
2209 
2210 	/* find the aggregator that this port is connected to */
2211 	bond_for_each_slave(bond, slave_iter, iter) {
2212 		temp_aggregator = &(SLAVE_AD_INFO(slave_iter)->aggregator);
2213 		prev_port = NULL;
2214 		/* search the port in the aggregator's related ports */
2215 		for (temp_port = temp_aggregator->lag_ports; temp_port;
2216 		     prev_port = temp_port,
2217 		     temp_port = temp_port->next_port_in_aggregator) {
2218 			if (temp_port == port) {
2219 				/* the aggregator found - detach the port from
2220 				 * this aggregator
2221 				 */
2222 				if (prev_port)
2223 					prev_port->next_port_in_aggregator = temp_port->next_port_in_aggregator;
2224 				else
2225 					temp_aggregator->lag_ports = temp_port->next_port_in_aggregator;
2226 				temp_aggregator->num_of_ports--;
2227 				if (__agg_active_ports(temp_aggregator) == 0) {
2228 					select_new_active_agg = temp_aggregator->is_active;
2229 					ad_clear_agg(temp_aggregator);
2230 					if (select_new_active_agg) {
2231 						slave_info(bond->dev, slave->dev, "Removing an active aggregator\n");
2232 						/* select new active aggregator */
2233 						ad_agg_selection_logic(__get_first_agg(port),
2234 							               &dummy_slave_update);
2235 					}
2236 				}
2237 				break;
2238 			}
2239 		}
2240 	}
2241 	port->slave = NULL;
2242 
2243 out:
2244 	spin_unlock_bh(&bond->mode_lock);
2245 }
2246 
2247 /**
2248  * bond_3ad_update_ad_actor_settings - reflect change of actor settings to ports
2249  * @bond: bonding struct to work on
2250  *
2251  * If an ad_actor setting gets changed we need to update the individual port
2252  * settings so the bond device will use the new values when it gets upped.
2253  */
2254 void bond_3ad_update_ad_actor_settings(struct bonding *bond)
2255 {
2256 	struct list_head *iter;
2257 	struct slave *slave;
2258 
2259 	ASSERT_RTNL();
2260 
2261 	BOND_AD_INFO(bond).system.sys_priority = bond->params.ad_actor_sys_prio;
2262 	if (is_zero_ether_addr(bond->params.ad_actor_system))
2263 		BOND_AD_INFO(bond).system.sys_mac_addr =
2264 		    *((struct mac_addr *)bond->dev->dev_addr);
2265 	else
2266 		BOND_AD_INFO(bond).system.sys_mac_addr =
2267 		    *((struct mac_addr *)bond->params.ad_actor_system);
2268 
2269 	spin_lock_bh(&bond->mode_lock);
2270 	bond_for_each_slave(bond, slave, iter) {
2271 		struct port *port = &(SLAVE_AD_INFO(slave))->port;
2272 
2273 		__ad_actor_update_port(port);
2274 		port->ntt = true;
2275 	}
2276 	spin_unlock_bh(&bond->mode_lock);
2277 }
2278 
2279 /**
2280  * bond_3ad_state_machine_handler - handle state machines timeout
2281  * @work: work context to fetch bonding struct to work on from
2282  *
2283  * The state machine handling concept in this module is to check every tick
2284  * which state machine should operate any function. The execution order is
2285  * round robin, so when we have an interaction between state machines, the
2286  * reply of one to each other might be delayed until next tick.
2287  *
2288  * This function also complete the initialization when the agg_select_timer
2289  * times out, and it selects an aggregator for the ports that are yet not
2290  * related to any aggregator, and selects the active aggregator for a bond.
2291  */
2292 void bond_3ad_state_machine_handler(struct work_struct *work)
2293 {
2294 	struct bonding *bond = container_of(work, struct bonding,
2295 					    ad_work.work);
2296 	struct aggregator *aggregator;
2297 	struct list_head *iter;
2298 	struct slave *slave;
2299 	struct port *port;
2300 	bool should_notify_rtnl = BOND_SLAVE_NOTIFY_LATER;
2301 	bool update_slave_arr = false;
2302 
2303 	/* Lock to protect data accessed by all (e.g., port->sm_vars) and
2304 	 * against running with bond_3ad_unbind_slave. ad_rx_machine may run
2305 	 * concurrently due to incoming LACPDU as well.
2306 	 */
2307 	spin_lock_bh(&bond->mode_lock);
2308 	rcu_read_lock();
2309 
2310 	/* check if there are any slaves */
2311 	if (!bond_has_slaves(bond))
2312 		goto re_arm;
2313 
2314 	/* check if agg_select_timer timer after initialize is timed out */
2315 	if (BOND_AD_INFO(bond).agg_select_timer &&
2316 	    !(--BOND_AD_INFO(bond).agg_select_timer)) {
2317 		slave = bond_first_slave_rcu(bond);
2318 		port = slave ? &(SLAVE_AD_INFO(slave)->port) : NULL;
2319 
2320 		/* select the active aggregator for the bond */
2321 		if (port) {
2322 			if (!port->slave) {
2323 				net_warn_ratelimited("%s: Warning: bond's first port is uninitialized\n",
2324 						     bond->dev->name);
2325 				goto re_arm;
2326 			}
2327 
2328 			aggregator = __get_first_agg(port);
2329 			ad_agg_selection_logic(aggregator, &update_slave_arr);
2330 		}
2331 		bond_3ad_set_carrier(bond);
2332 	}
2333 
2334 	/* for each port run the state machines */
2335 	bond_for_each_slave_rcu(bond, slave, iter) {
2336 		port = &(SLAVE_AD_INFO(slave)->port);
2337 		if (!port->slave) {
2338 			net_warn_ratelimited("%s: Warning: Found an uninitialized port\n",
2339 					    bond->dev->name);
2340 			goto re_arm;
2341 		}
2342 
2343 		ad_rx_machine(NULL, port);
2344 		ad_periodic_machine(port);
2345 		ad_port_selection_logic(port, &update_slave_arr);
2346 		ad_mux_machine(port, &update_slave_arr);
2347 		ad_tx_machine(port);
2348 		ad_churn_machine(port);
2349 
2350 		/* turn off the BEGIN bit, since we already handled it */
2351 		if (port->sm_vars & AD_PORT_BEGIN)
2352 			port->sm_vars &= ~AD_PORT_BEGIN;
2353 	}
2354 
2355 re_arm:
2356 	bond_for_each_slave_rcu(bond, slave, iter) {
2357 		if (slave->should_notify) {
2358 			should_notify_rtnl = BOND_SLAVE_NOTIFY_NOW;
2359 			break;
2360 		}
2361 	}
2362 	rcu_read_unlock();
2363 	spin_unlock_bh(&bond->mode_lock);
2364 
2365 	if (update_slave_arr)
2366 		bond_slave_arr_work_rearm(bond, 0);
2367 
2368 	if (should_notify_rtnl && rtnl_trylock()) {
2369 		bond_slave_state_notify(bond);
2370 		rtnl_unlock();
2371 	}
2372 	queue_delayed_work(bond->wq, &bond->ad_work, ad_delta_in_ticks);
2373 }
2374 
2375 /**
2376  * bond_3ad_rx_indication - handle a received frame
2377  * @lacpdu: received lacpdu
2378  * @slave: slave struct to work on
2379  *
2380  * It is assumed that frames that were sent on this NIC don't returned as new
2381  * received frames (loopback). Since only the payload is given to this
2382  * function, it check for loopback.
2383  */
2384 static int bond_3ad_rx_indication(struct lacpdu *lacpdu, struct slave *slave)
2385 {
2386 	struct bonding *bond = slave->bond;
2387 	int ret = RX_HANDLER_ANOTHER;
2388 	struct bond_marker *marker;
2389 	struct port *port;
2390 	atomic64_t *stat;
2391 
2392 	port = &(SLAVE_AD_INFO(slave)->port);
2393 	if (!port->slave) {
2394 		net_warn_ratelimited("%s: Warning: port of slave %s is uninitialized\n",
2395 				     slave->dev->name, slave->bond->dev->name);
2396 		return ret;
2397 	}
2398 
2399 	switch (lacpdu->subtype) {
2400 	case AD_TYPE_LACPDU:
2401 		ret = RX_HANDLER_CONSUMED;
2402 		slave_dbg(slave->bond->dev, slave->dev,
2403 			  "Received LACPDU on port %d\n",
2404 			  port->actor_port_number);
2405 		/* Protect against concurrent state machines */
2406 		spin_lock(&slave->bond->mode_lock);
2407 		ad_rx_machine(lacpdu, port);
2408 		spin_unlock(&slave->bond->mode_lock);
2409 		break;
2410 	case AD_TYPE_MARKER:
2411 		ret = RX_HANDLER_CONSUMED;
2412 		/* No need to convert fields to Little Endian since we
2413 		 * don't use the marker's fields.
2414 		 */
2415 		marker = (struct bond_marker *)lacpdu;
2416 		switch (marker->tlv_type) {
2417 		case AD_MARKER_INFORMATION_SUBTYPE:
2418 			slave_dbg(slave->bond->dev, slave->dev, "Received Marker Information on port %d\n",
2419 				  port->actor_port_number);
2420 			ad_marker_info_received(marker, port);
2421 			break;
2422 		case AD_MARKER_RESPONSE_SUBTYPE:
2423 			slave_dbg(slave->bond->dev, slave->dev, "Received Marker Response on port %d\n",
2424 				  port->actor_port_number);
2425 			ad_marker_response_received(marker, port);
2426 			break;
2427 		default:
2428 			slave_dbg(slave->bond->dev, slave->dev, "Received an unknown Marker subtype on port %d\n",
2429 				  port->actor_port_number);
2430 			stat = &SLAVE_AD_INFO(slave)->stats.marker_unknown_rx;
2431 			atomic64_inc(stat);
2432 			stat = &BOND_AD_INFO(bond).stats.marker_unknown_rx;
2433 			atomic64_inc(stat);
2434 		}
2435 		break;
2436 	default:
2437 		atomic64_inc(&SLAVE_AD_INFO(slave)->stats.lacpdu_unknown_rx);
2438 		atomic64_inc(&BOND_AD_INFO(bond).stats.lacpdu_unknown_rx);
2439 	}
2440 
2441 	return ret;
2442 }
2443 
2444 /**
2445  * ad_update_actor_keys - Update the oper / admin keys for a port based on
2446  * its current speed and duplex settings.
2447  *
2448  * @port: the port we'are looking at
2449  * @reset: Boolean to just reset the speed and the duplex part of the key
2450  *
2451  * The logic to change the oper / admin keys is:
2452  * (a) A full duplex port can participate in LACP with partner.
2453  * (b) When the speed is changed, LACP need to be reinitiated.
2454  */
2455 static void ad_update_actor_keys(struct port *port, bool reset)
2456 {
2457 	u8 duplex = 0;
2458 	u16 ospeed = 0, speed = 0;
2459 	u16 old_oper_key = port->actor_oper_port_key;
2460 
2461 	port->actor_admin_port_key &= ~(AD_SPEED_KEY_MASKS|AD_DUPLEX_KEY_MASKS);
2462 	if (!reset) {
2463 		speed = __get_link_speed(port);
2464 		ospeed = (old_oper_key & AD_SPEED_KEY_MASKS) >> 1;
2465 		duplex = __get_duplex(port);
2466 		port->actor_admin_port_key |= (speed << 1) | duplex;
2467 	}
2468 	port->actor_oper_port_key = port->actor_admin_port_key;
2469 
2470 	if (old_oper_key != port->actor_oper_port_key) {
2471 		/* Only 'duplex' port participates in LACP */
2472 		if (duplex)
2473 			port->sm_vars |= AD_PORT_LACP_ENABLED;
2474 		else
2475 			port->sm_vars &= ~AD_PORT_LACP_ENABLED;
2476 
2477 		if (!reset) {
2478 			if (!speed) {
2479 				slave_err(port->slave->bond->dev,
2480 					  port->slave->dev,
2481 					  "speed changed to 0 on port %d\n",
2482 					  port->actor_port_number);
2483 			} else if (duplex && ospeed != speed) {
2484 				/* Speed change restarts LACP state-machine */
2485 				port->sm_vars |= AD_PORT_BEGIN;
2486 			}
2487 		}
2488 	}
2489 }
2490 
2491 /**
2492  * bond_3ad_adapter_speed_duplex_changed - handle a slave's speed / duplex
2493  * change indication
2494  *
2495  * @slave: slave struct to work on
2496  *
2497  * Handle reselection of aggregator (if needed) for this port.
2498  */
2499 void bond_3ad_adapter_speed_duplex_changed(struct slave *slave)
2500 {
2501 	struct port *port;
2502 
2503 	port = &(SLAVE_AD_INFO(slave)->port);
2504 
2505 	/* if slave is null, the whole port is not initialized */
2506 	if (!port->slave) {
2507 		slave_warn(slave->bond->dev, slave->dev,
2508 			   "speed/duplex changed for uninitialized port\n");
2509 		return;
2510 	}
2511 
2512 	spin_lock_bh(&slave->bond->mode_lock);
2513 	ad_update_actor_keys(port, false);
2514 	spin_unlock_bh(&slave->bond->mode_lock);
2515 	slave_dbg(slave->bond->dev, slave->dev, "Port %d changed speed/duplex\n",
2516 		  port->actor_port_number);
2517 }
2518 
2519 /**
2520  * bond_3ad_handle_link_change - handle a slave's link status change indication
2521  * @slave: slave struct to work on
2522  * @link: whether the link is now up or down
2523  *
2524  * Handle reselection of aggregator (if needed) for this port.
2525  */
2526 void bond_3ad_handle_link_change(struct slave *slave, char link)
2527 {
2528 	struct aggregator *agg;
2529 	struct port *port;
2530 	bool dummy;
2531 
2532 	port = &(SLAVE_AD_INFO(slave)->port);
2533 
2534 	/* if slave is null, the whole port is not initialized */
2535 	if (!port->slave) {
2536 		slave_warn(slave->bond->dev, slave->dev, "link status changed for uninitialized port\n");
2537 		return;
2538 	}
2539 
2540 	spin_lock_bh(&slave->bond->mode_lock);
2541 	/* on link down we are zeroing duplex and speed since
2542 	 * some of the adaptors(ce1000.lan) report full duplex/speed
2543 	 * instead of N/A(duplex) / 0(speed).
2544 	 *
2545 	 * on link up we are forcing recheck on the duplex and speed since
2546 	 * some of he adaptors(ce1000.lan) report.
2547 	 */
2548 	if (link == BOND_LINK_UP) {
2549 		port->is_enabled = true;
2550 		ad_update_actor_keys(port, false);
2551 	} else {
2552 		/* link has failed */
2553 		port->is_enabled = false;
2554 		ad_update_actor_keys(port, true);
2555 	}
2556 	agg = __get_first_agg(port);
2557 	ad_agg_selection_logic(agg, &dummy);
2558 
2559 	spin_unlock_bh(&slave->bond->mode_lock);
2560 
2561 	slave_dbg(slave->bond->dev, slave->dev, "Port %d changed link status to %s\n",
2562 		  port->actor_port_number,
2563 		  link == BOND_LINK_UP ? "UP" : "DOWN");
2564 
2565 	/* RTNL is held and mode_lock is released so it's safe
2566 	 * to update slave_array here.
2567 	 */
2568 	bond_update_slave_arr(slave->bond, NULL);
2569 }
2570 
2571 /**
2572  * bond_3ad_set_carrier - set link state for bonding master
2573  * @bond: bonding structure
2574  *
2575  * if we have an active aggregator, we're up, if not, we're down.
2576  * Presumes that we cannot have an active aggregator if there are
2577  * no slaves with link up.
2578  *
2579  * This behavior complies with IEEE 802.3 section 43.3.9.
2580  *
2581  * Called by bond_set_carrier(). Return zero if carrier state does not
2582  * change, nonzero if it does.
2583  */
2584 int bond_3ad_set_carrier(struct bonding *bond)
2585 {
2586 	struct aggregator *active;
2587 	struct slave *first_slave;
2588 	int ret = 1;
2589 
2590 	rcu_read_lock();
2591 	first_slave = bond_first_slave_rcu(bond);
2592 	if (!first_slave) {
2593 		ret = 0;
2594 		goto out;
2595 	}
2596 	active = __get_active_agg(&(SLAVE_AD_INFO(first_slave)->aggregator));
2597 	if (active) {
2598 		/* are enough slaves available to consider link up? */
2599 		if (__agg_active_ports(active) < bond->params.min_links) {
2600 			if (netif_carrier_ok(bond->dev)) {
2601 				netif_carrier_off(bond->dev);
2602 				goto out;
2603 			}
2604 		} else if (!netif_carrier_ok(bond->dev)) {
2605 			netif_carrier_on(bond->dev);
2606 			goto out;
2607 		}
2608 	} else if (netif_carrier_ok(bond->dev)) {
2609 		netif_carrier_off(bond->dev);
2610 	}
2611 out:
2612 	rcu_read_unlock();
2613 	return ret;
2614 }
2615 
2616 /**
2617  * __bond_3ad_get_active_agg_info - get information of the active aggregator
2618  * @bond: bonding struct to work on
2619  * @ad_info: ad_info struct to fill with the bond's info
2620  *
2621  * Returns:   0 on success
2622  *          < 0 on error
2623  */
2624 int __bond_3ad_get_active_agg_info(struct bonding *bond,
2625 				   struct ad_info *ad_info)
2626 {
2627 	struct aggregator *aggregator = NULL;
2628 	struct list_head *iter;
2629 	struct slave *slave;
2630 	struct port *port;
2631 
2632 	bond_for_each_slave_rcu(bond, slave, iter) {
2633 		port = &(SLAVE_AD_INFO(slave)->port);
2634 		if (port->aggregator && port->aggregator->is_active) {
2635 			aggregator = port->aggregator;
2636 			break;
2637 		}
2638 	}
2639 
2640 	if (!aggregator)
2641 		return -1;
2642 
2643 	ad_info->aggregator_id = aggregator->aggregator_identifier;
2644 	ad_info->ports = __agg_active_ports(aggregator);
2645 	ad_info->actor_key = aggregator->actor_oper_aggregator_key;
2646 	ad_info->partner_key = aggregator->partner_oper_aggregator_key;
2647 	ether_addr_copy(ad_info->partner_system,
2648 			aggregator->partner_system.mac_addr_value);
2649 	return 0;
2650 }
2651 
2652 int bond_3ad_get_active_agg_info(struct bonding *bond, struct ad_info *ad_info)
2653 {
2654 	int ret;
2655 
2656 	rcu_read_lock();
2657 	ret = __bond_3ad_get_active_agg_info(bond, ad_info);
2658 	rcu_read_unlock();
2659 
2660 	return ret;
2661 }
2662 
2663 int bond_3ad_lacpdu_recv(const struct sk_buff *skb, struct bonding *bond,
2664 			 struct slave *slave)
2665 {
2666 	struct lacpdu *lacpdu, _lacpdu;
2667 
2668 	if (skb->protocol != PKT_TYPE_LACPDU)
2669 		return RX_HANDLER_ANOTHER;
2670 
2671 	if (!MAC_ADDRESS_EQUAL(eth_hdr(skb)->h_dest, lacpdu_mcast_addr))
2672 		return RX_HANDLER_ANOTHER;
2673 
2674 	lacpdu = skb_header_pointer(skb, 0, sizeof(_lacpdu), &_lacpdu);
2675 	if (!lacpdu) {
2676 		atomic64_inc(&SLAVE_AD_INFO(slave)->stats.lacpdu_illegal_rx);
2677 		atomic64_inc(&BOND_AD_INFO(bond).stats.lacpdu_illegal_rx);
2678 		return RX_HANDLER_ANOTHER;
2679 	}
2680 
2681 	return bond_3ad_rx_indication(lacpdu, slave);
2682 }
2683 
2684 /**
2685  * bond_3ad_update_lacp_rate - change the lacp rate
2686  * @bond: bonding struct
2687  *
2688  * When modify lacp_rate parameter via sysfs,
2689  * update actor_oper_port_state of each port.
2690  *
2691  * Hold bond->mode_lock,
2692  * so we can modify port->actor_oper_port_state,
2693  * no matter bond is up or down.
2694  */
2695 void bond_3ad_update_lacp_rate(struct bonding *bond)
2696 {
2697 	struct port *port = NULL;
2698 	struct list_head *iter;
2699 	struct slave *slave;
2700 	int lacp_fast;
2701 
2702 	lacp_fast = bond->params.lacp_fast;
2703 	spin_lock_bh(&bond->mode_lock);
2704 	bond_for_each_slave(bond, slave, iter) {
2705 		port = &(SLAVE_AD_INFO(slave)->port);
2706 		if (lacp_fast)
2707 			port->actor_oper_port_state |= LACP_STATE_LACP_TIMEOUT;
2708 		else
2709 			port->actor_oper_port_state &= ~LACP_STATE_LACP_TIMEOUT;
2710 	}
2711 	spin_unlock_bh(&bond->mode_lock);
2712 }
2713 
2714 size_t bond_3ad_stats_size(void)
2715 {
2716 	return nla_total_size_64bit(sizeof(u64)) + /* BOND_3AD_STAT_LACPDU_RX */
2717 	       nla_total_size_64bit(sizeof(u64)) + /* BOND_3AD_STAT_LACPDU_TX */
2718 	       nla_total_size_64bit(sizeof(u64)) + /* BOND_3AD_STAT_LACPDU_UNKNOWN_RX */
2719 	       nla_total_size_64bit(sizeof(u64)) + /* BOND_3AD_STAT_LACPDU_ILLEGAL_RX */
2720 	       nla_total_size_64bit(sizeof(u64)) + /* BOND_3AD_STAT_MARKER_RX */
2721 	       nla_total_size_64bit(sizeof(u64)) + /* BOND_3AD_STAT_MARKER_TX */
2722 	       nla_total_size_64bit(sizeof(u64)) + /* BOND_3AD_STAT_MARKER_RESP_RX */
2723 	       nla_total_size_64bit(sizeof(u64)) + /* BOND_3AD_STAT_MARKER_RESP_TX */
2724 	       nla_total_size_64bit(sizeof(u64)); /* BOND_3AD_STAT_MARKER_UNKNOWN_RX */
2725 }
2726 
2727 int bond_3ad_stats_fill(struct sk_buff *skb, struct bond_3ad_stats *stats)
2728 {
2729 	u64 val;
2730 
2731 	val = atomic64_read(&stats->lacpdu_rx);
2732 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_LACPDU_RX, val,
2733 			      BOND_3AD_STAT_PAD))
2734 		return -EMSGSIZE;
2735 	val = atomic64_read(&stats->lacpdu_tx);
2736 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_LACPDU_TX, val,
2737 			      BOND_3AD_STAT_PAD))
2738 		return -EMSGSIZE;
2739 	val = atomic64_read(&stats->lacpdu_unknown_rx);
2740 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_LACPDU_UNKNOWN_RX, val,
2741 			      BOND_3AD_STAT_PAD))
2742 		return -EMSGSIZE;
2743 	val = atomic64_read(&stats->lacpdu_illegal_rx);
2744 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_LACPDU_ILLEGAL_RX, val,
2745 			      BOND_3AD_STAT_PAD))
2746 		return -EMSGSIZE;
2747 
2748 	val = atomic64_read(&stats->marker_rx);
2749 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_MARKER_RX, val,
2750 			      BOND_3AD_STAT_PAD))
2751 		return -EMSGSIZE;
2752 	val = atomic64_read(&stats->marker_tx);
2753 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_MARKER_TX, val,
2754 			      BOND_3AD_STAT_PAD))
2755 		return -EMSGSIZE;
2756 	val = atomic64_read(&stats->marker_resp_rx);
2757 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_MARKER_RESP_RX, val,
2758 			      BOND_3AD_STAT_PAD))
2759 		return -EMSGSIZE;
2760 	val = atomic64_read(&stats->marker_resp_tx);
2761 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_MARKER_RESP_TX, val,
2762 			      BOND_3AD_STAT_PAD))
2763 		return -EMSGSIZE;
2764 	val = atomic64_read(&stats->marker_unknown_rx);
2765 	if (nla_put_u64_64bit(skb, BOND_3AD_STAT_MARKER_UNKNOWN_RX, val,
2766 			      BOND_3AD_STAT_PAD))
2767 		return -EMSGSIZE;
2768 
2769 	return 0;
2770 }
2771