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