1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
8 #include <rte_malloc.h>
9 #include <rte_ethdev_driver.h>
11 #include <rte_bus_vdev.h>
12 #include <rte_kvargs.h>
14 #include "rte_eth_bond.h"
15 #include "rte_eth_bond_private.h"
16 #include "rte_eth_bond_8023ad_private.h"
19 check_for_bonded_ethdev(const struct rte_eth_dev *eth_dev)
21 /* Check valid pointer */
22 if (eth_dev->device->driver->name == NULL)
25 /* return 0 if driver name matches */
26 return eth_dev->device->driver->name != pmd_bond_drv.driver.name;
30 valid_bonded_port_id(uint16_t port_id)
32 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -1);
33 return check_for_bonded_ethdev(&rte_eth_devices[port_id]);
37 check_for_master_bonded_ethdev(const struct rte_eth_dev *eth_dev)
40 struct bond_dev_private *internals;
42 if (check_for_bonded_ethdev(eth_dev) != 0)
45 internals = eth_dev->data->dev_private;
47 /* Check if any of slave devices is a bonded device */
48 for (i = 0; i < internals->slave_count; i++)
49 if (valid_bonded_port_id(internals->slaves[i].port_id) == 0)
56 valid_slave_port_id(uint16_t port_id, uint8_t mode)
58 RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -1);
60 /* Verify that port_id refers to a non bonded port */
61 if (check_for_bonded_ethdev(&rte_eth_devices[port_id]) == 0 &&
62 mode == BONDING_MODE_8023AD) {
63 RTE_BOND_LOG(ERR, "Cannot add slave to bonded device in 802.3ad"
64 " mode as slave is also a bonded device, only "
65 "physical devices can be support in this mode.");
73 activate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id)
75 struct bond_dev_private *internals = eth_dev->data->dev_private;
76 uint8_t active_count = internals->active_slave_count;
78 if (internals->mode == BONDING_MODE_8023AD)
79 bond_mode_8023ad_activate_slave(eth_dev, port_id);
81 if (internals->mode == BONDING_MODE_TLB
82 || internals->mode == BONDING_MODE_ALB) {
84 internals->tlb_slaves_order[active_count] = port_id;
87 RTE_ASSERT(internals->active_slave_count <
88 (RTE_DIM(internals->active_slaves) - 1));
90 internals->active_slaves[internals->active_slave_count] = port_id;
91 internals->active_slave_count++;
93 if (internals->mode == BONDING_MODE_TLB)
94 bond_tlb_activate_slave(internals);
95 if (internals->mode == BONDING_MODE_ALB)
96 bond_mode_alb_client_list_upd(eth_dev);
100 deactivate_slave(struct rte_eth_dev *eth_dev, uint16_t port_id)
103 struct bond_dev_private *internals = eth_dev->data->dev_private;
104 uint16_t active_count = internals->active_slave_count;
106 if (internals->mode == BONDING_MODE_8023AD) {
107 bond_mode_8023ad_stop(eth_dev);
108 bond_mode_8023ad_deactivate_slave(eth_dev, port_id);
109 } else if (internals->mode == BONDING_MODE_TLB
110 || internals->mode == BONDING_MODE_ALB)
111 bond_tlb_disable(internals);
113 slave_pos = find_slave_by_id(internals->active_slaves, active_count,
116 /* If slave was not at the end of the list
117 * shift active slaves up active array list */
118 if (slave_pos < active_count) {
120 memmove(internals->active_slaves + slave_pos,
121 internals->active_slaves + slave_pos + 1,
122 (active_count - slave_pos) *
123 sizeof(internals->active_slaves[0]));
126 RTE_ASSERT(active_count < RTE_DIM(internals->active_slaves));
127 internals->active_slave_count = active_count;
129 if (eth_dev->data->dev_started) {
130 if (internals->mode == BONDING_MODE_8023AD) {
131 bond_mode_8023ad_start(eth_dev);
132 } else if (internals->mode == BONDING_MODE_TLB) {
133 bond_tlb_enable(internals);
134 } else if (internals->mode == BONDING_MODE_ALB) {
135 bond_tlb_enable(internals);
136 bond_mode_alb_client_list_upd(eth_dev);
142 rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id)
144 struct bond_dev_private *internals;
150 RTE_BOND_LOG(ERR, "Invalid name specified");
154 ret = snprintf(devargs, sizeof(devargs),
155 "driver=net_bonding,mode=%d,socket_id=%d", mode, socket_id);
156 if (ret < 0 || ret >= (int)sizeof(devargs))
159 ret = rte_vdev_init(name, devargs);
163 ret = rte_eth_dev_get_port_by_name(name, &port_id);
167 * To make bond_ethdev_configure() happy we need to free the
168 * internals->kvlist here.
170 * Also see comment in bond_ethdev_configure().
172 internals = rte_eth_devices[port_id].data->dev_private;
173 rte_kvargs_free(internals->kvlist);
174 internals->kvlist = NULL;
180 rte_eth_bond_free(const char *name)
182 return rte_vdev_uninit(name);
186 slave_vlan_filter_set(uint16_t bonded_port_id, uint16_t slave_port_id)
188 struct rte_eth_dev *bonded_eth_dev;
189 struct bond_dev_private *internals;
196 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
197 if (bonded_eth_dev->data->dev_conf.rxmode.hw_vlan_filter == 0)
200 internals = bonded_eth_dev->data->dev_private;
201 found = rte_bitmap_scan(internals->vlan_filter_bmp, &pos, &slab);
211 for (i = 0, mask = 1;
212 i < RTE_BITMAP_SLAB_BIT_SIZE;
214 if (unlikely(slab & mask))
215 res = rte_eth_dev_vlan_filter(slave_port_id,
218 found = rte_bitmap_scan(internals->vlan_filter_bmp,
220 } while (found && first != pos && res == 0);
226 __eth_bond_slave_add_lock_free(uint16_t bonded_port_id, uint16_t slave_port_id)
228 struct rte_eth_dev *bonded_eth_dev, *slave_eth_dev;
229 struct bond_dev_private *internals;
230 struct rte_eth_link link_props;
231 struct rte_eth_dev_info dev_info;
233 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
234 internals = bonded_eth_dev->data->dev_private;
236 if (valid_slave_port_id(slave_port_id, internals->mode) != 0)
239 slave_eth_dev = &rte_eth_devices[slave_port_id];
240 if (slave_eth_dev->data->dev_flags & RTE_ETH_DEV_BONDED_SLAVE) {
241 RTE_BOND_LOG(ERR, "Slave device is already a slave of a bonded device");
245 rte_eth_dev_info_get(slave_port_id, &dev_info);
246 if (dev_info.max_rx_pktlen < internals->max_rx_pktlen) {
247 RTE_BOND_LOG(ERR, "Slave (port %u) max_rx_pktlen too small",
252 slave_add(internals, slave_eth_dev);
254 /* We need to store slaves reta_size to be able to synchronize RETA for all
255 * slave devices even if its sizes are different.
257 internals->slaves[internals->slave_count].reta_size = dev_info.reta_size;
259 if (internals->slave_count < 1) {
260 /* if MAC is not user defined then use MAC of first slave add to
262 if (!internals->user_defined_mac) {
263 if (mac_address_set(bonded_eth_dev,
264 slave_eth_dev->data->mac_addrs)) {
265 RTE_BOND_LOG(ERR, "Failed to set MAC address");
270 /* Inherit eth dev link properties from first slave */
271 link_properties_set(bonded_eth_dev,
272 &(slave_eth_dev->data->dev_link));
274 /* Make primary slave */
275 internals->primary_port = slave_port_id;
276 internals->current_primary_port = slave_port_id;
278 /* Inherit queues settings from first slave */
279 internals->nb_rx_queues = slave_eth_dev->data->nb_rx_queues;
280 internals->nb_tx_queues = slave_eth_dev->data->nb_tx_queues;
282 internals->reta_size = dev_info.reta_size;
284 /* Take the first dev's offload capabilities */
285 internals->rx_offload_capa = dev_info.rx_offload_capa;
286 internals->tx_offload_capa = dev_info.tx_offload_capa;
287 internals->flow_type_rss_offloads = dev_info.flow_type_rss_offloads;
289 /* Inherit first slave's max rx packet size */
290 internals->candidate_max_rx_pktlen = dev_info.max_rx_pktlen;
293 internals->rx_offload_capa &= dev_info.rx_offload_capa;
294 internals->tx_offload_capa &= dev_info.tx_offload_capa;
295 internals->flow_type_rss_offloads &= dev_info.flow_type_rss_offloads;
297 if (link_properties_valid(bonded_eth_dev,
298 &slave_eth_dev->data->dev_link) != 0) {
299 RTE_BOND_LOG(ERR, "Invalid link properties for slave %d"
300 " in bonding mode %d", slave_port_id,
305 /* RETA size is GCD of all slaves RETA sizes, so, if all sizes will be
306 * the power of 2, the lower one is GCD
308 if (internals->reta_size > dev_info.reta_size)
309 internals->reta_size = dev_info.reta_size;
311 if (!internals->max_rx_pktlen &&
312 dev_info.max_rx_pktlen < internals->candidate_max_rx_pktlen)
313 internals->candidate_max_rx_pktlen = dev_info.max_rx_pktlen;
316 bonded_eth_dev->data->dev_conf.rx_adv_conf.rss_conf.rss_hf &=
317 internals->flow_type_rss_offloads;
319 internals->slave_count++;
321 if (bonded_eth_dev->data->dev_started) {
322 if (slave_configure(bonded_eth_dev, slave_eth_dev) != 0) {
323 internals->slave_count--;
324 RTE_BOND_LOG(ERR, "rte_bond_slaves_configure: port=%d",
330 /* Add slave details to bonded device */
331 slave_eth_dev->data->dev_flags |= RTE_ETH_DEV_BONDED_SLAVE;
333 /* Update all slave devices MACs*/
334 mac_address_slaves_update(bonded_eth_dev);
336 /* Register link status change callback with bonded device pointer as
338 rte_eth_dev_callback_register(slave_port_id, RTE_ETH_EVENT_INTR_LSC,
339 bond_ethdev_lsc_event_callback, &bonded_eth_dev->data->port_id);
341 /* If bonded device is started then we can add the slave to our active
343 if (bonded_eth_dev->data->dev_started) {
344 rte_eth_link_get_nowait(slave_port_id, &link_props);
346 if (link_props.link_status == ETH_LINK_UP) {
347 if (internals->active_slave_count == 0 &&
348 !internals->user_defined_primary_port)
349 bond_ethdev_primary_set(internals,
352 if (find_slave_by_id(internals->active_slaves,
353 internals->active_slave_count,
354 slave_port_id) == internals->active_slave_count)
355 activate_slave(bonded_eth_dev, slave_port_id);
359 slave_vlan_filter_set(bonded_port_id, slave_port_id);
366 rte_eth_bond_slave_add(uint16_t bonded_port_id, uint16_t slave_port_id)
368 struct rte_eth_dev *bonded_eth_dev;
369 struct bond_dev_private *internals;
373 /* Verify that port id's are valid bonded and slave ports */
374 if (valid_bonded_port_id(bonded_port_id) != 0)
377 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
378 internals = bonded_eth_dev->data->dev_private;
380 rte_spinlock_lock(&internals->lock);
382 retval = __eth_bond_slave_add_lock_free(bonded_port_id, slave_port_id);
384 rte_spinlock_unlock(&internals->lock);
390 __eth_bond_slave_remove_lock_free(uint16_t bonded_port_id,
391 uint16_t slave_port_id)
393 struct rte_eth_dev *bonded_eth_dev;
394 struct bond_dev_private *internals;
395 struct rte_eth_dev *slave_eth_dev;
398 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
399 internals = bonded_eth_dev->data->dev_private;
401 if (valid_slave_port_id(slave_port_id, internals->mode) < 0)
404 /* first remove from active slave list */
405 slave_idx = find_slave_by_id(internals->active_slaves,
406 internals->active_slave_count, slave_port_id);
408 if (slave_idx < internals->active_slave_count)
409 deactivate_slave(bonded_eth_dev, slave_port_id);
412 /* now find in slave list */
413 for (i = 0; i < internals->slave_count; i++)
414 if (internals->slaves[i].port_id == slave_port_id) {
420 RTE_BOND_LOG(ERR, "Couldn't find slave in port list, slave count %d",
421 internals->slave_count);
425 /* Un-register link status change callback with bonded device pointer as
427 rte_eth_dev_callback_unregister(slave_port_id, RTE_ETH_EVENT_INTR_LSC,
428 bond_ethdev_lsc_event_callback,
429 &rte_eth_devices[bonded_port_id].data->port_id);
431 /* Restore original MAC address of slave device */
432 rte_eth_dev_default_mac_addr_set(slave_port_id,
433 &(internals->slaves[slave_idx].persisted_mac_addr));
435 slave_eth_dev = &rte_eth_devices[slave_port_id];
436 slave_remove(internals, slave_eth_dev);
437 slave_eth_dev->data->dev_flags &= (~RTE_ETH_DEV_BONDED_SLAVE);
439 /* first slave in the active list will be the primary by default,
440 * otherwise use first device in list */
441 if (internals->current_primary_port == slave_port_id) {
442 if (internals->active_slave_count > 0)
443 internals->current_primary_port = internals->active_slaves[0];
444 else if (internals->slave_count > 0)
445 internals->current_primary_port = internals->slaves[0].port_id;
447 internals->primary_port = 0;
450 if (internals->active_slave_count < 1) {
451 /* if no slaves are any longer attached to bonded device and MAC is not
452 * user defined then clear MAC of bonded device as it will be reset
453 * when a new slave is added */
454 if (internals->slave_count < 1 && !internals->user_defined_mac)
455 memset(rte_eth_devices[bonded_port_id].data->mac_addrs, 0,
456 sizeof(*(rte_eth_devices[bonded_port_id].data->mac_addrs)));
458 if (internals->slave_count == 0) {
459 internals->rx_offload_capa = 0;
460 internals->tx_offload_capa = 0;
461 internals->flow_type_rss_offloads = ETH_RSS_PROTO_MASK;
462 internals->reta_size = 0;
463 internals->candidate_max_rx_pktlen = 0;
464 internals->max_rx_pktlen = 0;
470 rte_eth_bond_slave_remove(uint16_t bonded_port_id, uint16_t slave_port_id)
472 struct rte_eth_dev *bonded_eth_dev;
473 struct bond_dev_private *internals;
476 if (valid_bonded_port_id(bonded_port_id) != 0)
479 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
480 internals = bonded_eth_dev->data->dev_private;
482 rte_spinlock_lock(&internals->lock);
484 retval = __eth_bond_slave_remove_lock_free(bonded_port_id, slave_port_id);
486 rte_spinlock_unlock(&internals->lock);
492 rte_eth_bond_mode_set(uint16_t bonded_port_id, uint8_t mode)
494 struct rte_eth_dev *bonded_eth_dev;
496 if (valid_bonded_port_id(bonded_port_id) != 0)
499 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
501 if (check_for_master_bonded_ethdev(bonded_eth_dev) != 0 &&
502 mode == BONDING_MODE_8023AD)
505 return bond_ethdev_mode_set(bonded_eth_dev, mode);
509 rte_eth_bond_mode_get(uint16_t bonded_port_id)
511 struct bond_dev_private *internals;
513 if (valid_bonded_port_id(bonded_port_id) != 0)
516 internals = rte_eth_devices[bonded_port_id].data->dev_private;
518 return internals->mode;
522 rte_eth_bond_primary_set(uint16_t bonded_port_id, uint16_t slave_port_id)
524 struct bond_dev_private *internals;
526 if (valid_bonded_port_id(bonded_port_id) != 0)
529 internals = rte_eth_devices[bonded_port_id].data->dev_private;
531 if (valid_slave_port_id(slave_port_id, internals->mode) != 0)
534 internals->user_defined_primary_port = 1;
535 internals->primary_port = slave_port_id;
537 bond_ethdev_primary_set(internals, slave_port_id);
543 rte_eth_bond_primary_get(uint16_t bonded_port_id)
545 struct bond_dev_private *internals;
547 if (valid_bonded_port_id(bonded_port_id) != 0)
550 internals = rte_eth_devices[bonded_port_id].data->dev_private;
552 if (internals->slave_count < 1)
555 return internals->current_primary_port;
559 rte_eth_bond_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
562 struct bond_dev_private *internals;
565 if (valid_bonded_port_id(bonded_port_id) != 0)
571 internals = rte_eth_devices[bonded_port_id].data->dev_private;
573 if (internals->slave_count > len)
576 for (i = 0; i < internals->slave_count; i++)
577 slaves[i] = internals->slaves[i].port_id;
579 return internals->slave_count;
583 rte_eth_bond_active_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
586 struct bond_dev_private *internals;
588 if (valid_bonded_port_id(bonded_port_id) != 0)
594 internals = rte_eth_devices[bonded_port_id].data->dev_private;
596 if (internals->active_slave_count > len)
599 memcpy(slaves, internals->active_slaves,
600 internals->active_slave_count * sizeof(internals->active_slaves[0]));
602 return internals->active_slave_count;
606 rte_eth_bond_mac_address_set(uint16_t bonded_port_id,
607 struct ether_addr *mac_addr)
609 struct rte_eth_dev *bonded_eth_dev;
610 struct bond_dev_private *internals;
612 if (valid_bonded_port_id(bonded_port_id) != 0)
615 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
616 internals = bonded_eth_dev->data->dev_private;
618 /* Set MAC Address of Bonded Device */
619 if (mac_address_set(bonded_eth_dev, mac_addr))
622 internals->user_defined_mac = 1;
624 /* Update all slave devices MACs*/
625 if (internals->slave_count > 0)
626 return mac_address_slaves_update(bonded_eth_dev);
632 rte_eth_bond_mac_address_reset(uint16_t bonded_port_id)
634 struct rte_eth_dev *bonded_eth_dev;
635 struct bond_dev_private *internals;
637 if (valid_bonded_port_id(bonded_port_id) != 0)
640 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
641 internals = bonded_eth_dev->data->dev_private;
643 internals->user_defined_mac = 0;
645 if (internals->slave_count > 0) {
646 /* Set MAC Address of Bonded Device */
647 if (mac_address_set(bonded_eth_dev,
648 &internals->slaves[internals->primary_port].persisted_mac_addr)
650 RTE_BOND_LOG(ERR, "Failed to set MAC address on bonded device");
653 /* Update all slave devices MAC addresses */
654 return mac_address_slaves_update(bonded_eth_dev);
656 /* No need to update anything as no slaves present */
661 rte_eth_bond_xmit_policy_set(uint16_t bonded_port_id, uint8_t policy)
663 struct bond_dev_private *internals;
665 if (valid_bonded_port_id(bonded_port_id) != 0)
668 internals = rte_eth_devices[bonded_port_id].data->dev_private;
671 case BALANCE_XMIT_POLICY_LAYER2:
672 internals->balance_xmit_policy = policy;
673 internals->burst_xmit_hash = burst_xmit_l2_hash;
675 case BALANCE_XMIT_POLICY_LAYER23:
676 internals->balance_xmit_policy = policy;
677 internals->burst_xmit_hash = burst_xmit_l23_hash;
679 case BALANCE_XMIT_POLICY_LAYER34:
680 internals->balance_xmit_policy = policy;
681 internals->burst_xmit_hash = burst_xmit_l34_hash;
691 rte_eth_bond_xmit_policy_get(uint16_t bonded_port_id)
693 struct bond_dev_private *internals;
695 if (valid_bonded_port_id(bonded_port_id) != 0)
698 internals = rte_eth_devices[bonded_port_id].data->dev_private;
700 return internals->balance_xmit_policy;
704 rte_eth_bond_link_monitoring_set(uint16_t bonded_port_id, uint32_t internal_ms)
706 struct bond_dev_private *internals;
708 if (valid_bonded_port_id(bonded_port_id) != 0)
711 internals = rte_eth_devices[bonded_port_id].data->dev_private;
712 internals->link_status_polling_interval_ms = internal_ms;
718 rte_eth_bond_link_monitoring_get(uint16_t bonded_port_id)
720 struct bond_dev_private *internals;
722 if (valid_bonded_port_id(bonded_port_id) != 0)
725 internals = rte_eth_devices[bonded_port_id].data->dev_private;
727 return internals->link_status_polling_interval_ms;
731 rte_eth_bond_link_down_prop_delay_set(uint16_t bonded_port_id,
735 struct bond_dev_private *internals;
737 if (valid_bonded_port_id(bonded_port_id) != 0)
740 internals = rte_eth_devices[bonded_port_id].data->dev_private;
741 internals->link_down_delay_ms = delay_ms;
747 rte_eth_bond_link_down_prop_delay_get(uint16_t bonded_port_id)
749 struct bond_dev_private *internals;
751 if (valid_bonded_port_id(bonded_port_id) != 0)
754 internals = rte_eth_devices[bonded_port_id].data->dev_private;
756 return internals->link_down_delay_ms;
760 rte_eth_bond_link_up_prop_delay_set(uint16_t bonded_port_id, uint32_t delay_ms)
763 struct bond_dev_private *internals;
765 if (valid_bonded_port_id(bonded_port_id) != 0)
768 internals = rte_eth_devices[bonded_port_id].data->dev_private;
769 internals->link_up_delay_ms = delay_ms;
775 rte_eth_bond_link_up_prop_delay_get(uint16_t bonded_port_id)
777 struct bond_dev_private *internals;
779 if (valid_bonded_port_id(bonded_port_id) != 0)
782 internals = rte_eth_devices[bonded_port_id].data->dev_private;
784 return internals->link_up_delay_ms;