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 uint16_t vlan_id = pos + i;
217 res = rte_eth_dev_vlan_filter(slave_port_id,
221 found = rte_bitmap_scan(internals->vlan_filter_bmp,
223 } while (found && first != pos && res == 0);
229 __eth_bond_slave_add_lock_free(uint16_t bonded_port_id, uint16_t slave_port_id)
231 struct rte_eth_dev *bonded_eth_dev, *slave_eth_dev;
232 struct bond_dev_private *internals;
233 struct rte_eth_link link_props;
234 struct rte_eth_dev_info dev_info;
236 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
237 internals = bonded_eth_dev->data->dev_private;
239 if (valid_slave_port_id(slave_port_id, internals->mode) != 0)
242 slave_eth_dev = &rte_eth_devices[slave_port_id];
243 if (slave_eth_dev->data->dev_flags & RTE_ETH_DEV_BONDED_SLAVE) {
244 RTE_BOND_LOG(ERR, "Slave device is already a slave of a bonded device");
248 rte_eth_dev_info_get(slave_port_id, &dev_info);
249 if (dev_info.max_rx_pktlen < internals->max_rx_pktlen) {
250 RTE_BOND_LOG(ERR, "Slave (port %u) max_rx_pktlen too small",
255 slave_add(internals, slave_eth_dev);
257 /* We need to store slaves reta_size to be able to synchronize RETA for all
258 * slave devices even if its sizes are different.
260 internals->slaves[internals->slave_count].reta_size = dev_info.reta_size;
262 if (internals->slave_count < 1) {
263 /* if MAC is not user defined then use MAC of first slave add to
265 if (!internals->user_defined_mac) {
266 if (mac_address_set(bonded_eth_dev,
267 slave_eth_dev->data->mac_addrs)) {
268 RTE_BOND_LOG(ERR, "Failed to set MAC address");
273 /* Inherit eth dev link properties from first slave */
274 link_properties_set(bonded_eth_dev,
275 &(slave_eth_dev->data->dev_link));
277 /* Make primary slave */
278 internals->primary_port = slave_port_id;
279 internals->current_primary_port = slave_port_id;
281 /* Inherit queues settings from first slave */
282 internals->nb_rx_queues = slave_eth_dev->data->nb_rx_queues;
283 internals->nb_tx_queues = slave_eth_dev->data->nb_tx_queues;
285 internals->reta_size = dev_info.reta_size;
287 /* Take the first dev's offload capabilities */
288 internals->rx_offload_capa = dev_info.rx_offload_capa;
289 internals->tx_offload_capa = dev_info.tx_offload_capa;
290 internals->flow_type_rss_offloads = dev_info.flow_type_rss_offloads;
292 /* Inherit first slave's max rx packet size */
293 internals->candidate_max_rx_pktlen = dev_info.max_rx_pktlen;
296 internals->rx_offload_capa &= dev_info.rx_offload_capa;
297 internals->tx_offload_capa &= dev_info.tx_offload_capa;
298 internals->flow_type_rss_offloads &= dev_info.flow_type_rss_offloads;
300 if (link_properties_valid(bonded_eth_dev,
301 &slave_eth_dev->data->dev_link) != 0) {
302 RTE_BOND_LOG(ERR, "Invalid link properties for slave %d"
303 " in bonding mode %d", slave_port_id,
308 /* RETA size is GCD of all slaves RETA sizes, so, if all sizes will be
309 * the power of 2, the lower one is GCD
311 if (internals->reta_size > dev_info.reta_size)
312 internals->reta_size = dev_info.reta_size;
314 if (!internals->max_rx_pktlen &&
315 dev_info.max_rx_pktlen < internals->candidate_max_rx_pktlen)
316 internals->candidate_max_rx_pktlen = dev_info.max_rx_pktlen;
319 bonded_eth_dev->data->dev_conf.rx_adv_conf.rss_conf.rss_hf &=
320 internals->flow_type_rss_offloads;
322 internals->slave_count++;
324 if (bonded_eth_dev->data->dev_started) {
325 if (slave_configure(bonded_eth_dev, slave_eth_dev) != 0) {
326 internals->slave_count--;
327 RTE_BOND_LOG(ERR, "rte_bond_slaves_configure: port=%d",
333 /* Add slave details to bonded device */
334 slave_eth_dev->data->dev_flags |= RTE_ETH_DEV_BONDED_SLAVE;
336 /* Update all slave devices MACs*/
337 mac_address_slaves_update(bonded_eth_dev);
339 /* Register link status change callback with bonded device pointer as
341 rte_eth_dev_callback_register(slave_port_id, RTE_ETH_EVENT_INTR_LSC,
342 bond_ethdev_lsc_event_callback, &bonded_eth_dev->data->port_id);
344 /* If bonded device is started then we can add the slave to our active
346 if (bonded_eth_dev->data->dev_started) {
347 rte_eth_link_get_nowait(slave_port_id, &link_props);
349 if (link_props.link_status == ETH_LINK_UP) {
350 if (internals->active_slave_count == 0 &&
351 !internals->user_defined_primary_port)
352 bond_ethdev_primary_set(internals,
355 if (find_slave_by_id(internals->active_slaves,
356 internals->active_slave_count,
357 slave_port_id) == internals->active_slave_count)
358 activate_slave(bonded_eth_dev, slave_port_id);
362 slave_vlan_filter_set(bonded_port_id, slave_port_id);
369 rte_eth_bond_slave_add(uint16_t bonded_port_id, uint16_t slave_port_id)
371 struct rte_eth_dev *bonded_eth_dev;
372 struct bond_dev_private *internals;
376 /* Verify that port id's are valid bonded and slave ports */
377 if (valid_bonded_port_id(bonded_port_id) != 0)
380 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
381 internals = bonded_eth_dev->data->dev_private;
383 rte_spinlock_lock(&internals->lock);
385 retval = __eth_bond_slave_add_lock_free(bonded_port_id, slave_port_id);
387 rte_spinlock_unlock(&internals->lock);
393 __eth_bond_slave_remove_lock_free(uint16_t bonded_port_id,
394 uint16_t slave_port_id)
396 struct rte_eth_dev *bonded_eth_dev;
397 struct bond_dev_private *internals;
398 struct rte_eth_dev *slave_eth_dev;
401 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
402 internals = bonded_eth_dev->data->dev_private;
404 if (valid_slave_port_id(slave_port_id, internals->mode) < 0)
407 /* first remove from active slave list */
408 slave_idx = find_slave_by_id(internals->active_slaves,
409 internals->active_slave_count, slave_port_id);
411 if (slave_idx < internals->active_slave_count)
412 deactivate_slave(bonded_eth_dev, slave_port_id);
415 /* now find in slave list */
416 for (i = 0; i < internals->slave_count; i++)
417 if (internals->slaves[i].port_id == slave_port_id) {
423 RTE_BOND_LOG(ERR, "Couldn't find slave in port list, slave count %d",
424 internals->slave_count);
428 /* Un-register link status change callback with bonded device pointer as
430 rte_eth_dev_callback_unregister(slave_port_id, RTE_ETH_EVENT_INTR_LSC,
431 bond_ethdev_lsc_event_callback,
432 &rte_eth_devices[bonded_port_id].data->port_id);
434 /* Restore original MAC address of slave device */
435 rte_eth_dev_default_mac_addr_set(slave_port_id,
436 &(internals->slaves[slave_idx].persisted_mac_addr));
438 slave_eth_dev = &rte_eth_devices[slave_port_id];
439 slave_remove(internals, slave_eth_dev);
440 slave_eth_dev->data->dev_flags &= (~RTE_ETH_DEV_BONDED_SLAVE);
442 /* first slave in the active list will be the primary by default,
443 * otherwise use first device in list */
444 if (internals->current_primary_port == slave_port_id) {
445 if (internals->active_slave_count > 0)
446 internals->current_primary_port = internals->active_slaves[0];
447 else if (internals->slave_count > 0)
448 internals->current_primary_port = internals->slaves[0].port_id;
450 internals->primary_port = 0;
453 if (internals->active_slave_count < 1) {
454 /* if no slaves are any longer attached to bonded device and MAC is not
455 * user defined then clear MAC of bonded device as it will be reset
456 * when a new slave is added */
457 if (internals->slave_count < 1 && !internals->user_defined_mac)
458 memset(rte_eth_devices[bonded_port_id].data->mac_addrs, 0,
459 sizeof(*(rte_eth_devices[bonded_port_id].data->mac_addrs)));
461 if (internals->slave_count == 0) {
462 internals->rx_offload_capa = 0;
463 internals->tx_offload_capa = 0;
464 internals->flow_type_rss_offloads = ETH_RSS_PROTO_MASK;
465 internals->reta_size = 0;
466 internals->candidate_max_rx_pktlen = 0;
467 internals->max_rx_pktlen = 0;
473 rte_eth_bond_slave_remove(uint16_t bonded_port_id, uint16_t slave_port_id)
475 struct rte_eth_dev *bonded_eth_dev;
476 struct bond_dev_private *internals;
479 if (valid_bonded_port_id(bonded_port_id) != 0)
482 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
483 internals = bonded_eth_dev->data->dev_private;
485 rte_spinlock_lock(&internals->lock);
487 retval = __eth_bond_slave_remove_lock_free(bonded_port_id, slave_port_id);
489 rte_spinlock_unlock(&internals->lock);
495 rte_eth_bond_mode_set(uint16_t bonded_port_id, uint8_t mode)
497 struct rte_eth_dev *bonded_eth_dev;
499 if (valid_bonded_port_id(bonded_port_id) != 0)
502 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
504 if (check_for_master_bonded_ethdev(bonded_eth_dev) != 0 &&
505 mode == BONDING_MODE_8023AD)
508 return bond_ethdev_mode_set(bonded_eth_dev, mode);
512 rte_eth_bond_mode_get(uint16_t bonded_port_id)
514 struct bond_dev_private *internals;
516 if (valid_bonded_port_id(bonded_port_id) != 0)
519 internals = rte_eth_devices[bonded_port_id].data->dev_private;
521 return internals->mode;
525 rte_eth_bond_primary_set(uint16_t bonded_port_id, uint16_t slave_port_id)
527 struct bond_dev_private *internals;
529 if (valid_bonded_port_id(bonded_port_id) != 0)
532 internals = rte_eth_devices[bonded_port_id].data->dev_private;
534 if (valid_slave_port_id(slave_port_id, internals->mode) != 0)
537 internals->user_defined_primary_port = 1;
538 internals->primary_port = slave_port_id;
540 bond_ethdev_primary_set(internals, slave_port_id);
546 rte_eth_bond_primary_get(uint16_t bonded_port_id)
548 struct bond_dev_private *internals;
550 if (valid_bonded_port_id(bonded_port_id) != 0)
553 internals = rte_eth_devices[bonded_port_id].data->dev_private;
555 if (internals->slave_count < 1)
558 return internals->current_primary_port;
562 rte_eth_bond_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
565 struct bond_dev_private *internals;
568 if (valid_bonded_port_id(bonded_port_id) != 0)
574 internals = rte_eth_devices[bonded_port_id].data->dev_private;
576 if (internals->slave_count > len)
579 for (i = 0; i < internals->slave_count; i++)
580 slaves[i] = internals->slaves[i].port_id;
582 return internals->slave_count;
586 rte_eth_bond_active_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
589 struct bond_dev_private *internals;
591 if (valid_bonded_port_id(bonded_port_id) != 0)
597 internals = rte_eth_devices[bonded_port_id].data->dev_private;
599 if (internals->active_slave_count > len)
602 memcpy(slaves, internals->active_slaves,
603 internals->active_slave_count * sizeof(internals->active_slaves[0]));
605 return internals->active_slave_count;
609 rte_eth_bond_mac_address_set(uint16_t bonded_port_id,
610 struct ether_addr *mac_addr)
612 struct rte_eth_dev *bonded_eth_dev;
613 struct bond_dev_private *internals;
615 if (valid_bonded_port_id(bonded_port_id) != 0)
618 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
619 internals = bonded_eth_dev->data->dev_private;
621 /* Set MAC Address of Bonded Device */
622 if (mac_address_set(bonded_eth_dev, mac_addr))
625 internals->user_defined_mac = 1;
627 /* Update all slave devices MACs*/
628 if (internals->slave_count > 0)
629 return mac_address_slaves_update(bonded_eth_dev);
635 rte_eth_bond_mac_address_reset(uint16_t bonded_port_id)
637 struct rte_eth_dev *bonded_eth_dev;
638 struct bond_dev_private *internals;
640 if (valid_bonded_port_id(bonded_port_id) != 0)
643 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
644 internals = bonded_eth_dev->data->dev_private;
646 internals->user_defined_mac = 0;
648 if (internals->slave_count > 0) {
649 /* Set MAC Address of Bonded Device */
650 if (mac_address_set(bonded_eth_dev,
651 &internals->slaves[internals->primary_port].persisted_mac_addr)
653 RTE_BOND_LOG(ERR, "Failed to set MAC address on bonded device");
656 /* Update all slave devices MAC addresses */
657 return mac_address_slaves_update(bonded_eth_dev);
659 /* No need to update anything as no slaves present */
664 rte_eth_bond_xmit_policy_set(uint16_t bonded_port_id, uint8_t policy)
666 struct bond_dev_private *internals;
668 if (valid_bonded_port_id(bonded_port_id) != 0)
671 internals = rte_eth_devices[bonded_port_id].data->dev_private;
674 case BALANCE_XMIT_POLICY_LAYER2:
675 internals->balance_xmit_policy = policy;
676 internals->burst_xmit_hash = burst_xmit_l2_hash;
678 case BALANCE_XMIT_POLICY_LAYER23:
679 internals->balance_xmit_policy = policy;
680 internals->burst_xmit_hash = burst_xmit_l23_hash;
682 case BALANCE_XMIT_POLICY_LAYER34:
683 internals->balance_xmit_policy = policy;
684 internals->burst_xmit_hash = burst_xmit_l34_hash;
694 rte_eth_bond_xmit_policy_get(uint16_t bonded_port_id)
696 struct bond_dev_private *internals;
698 if (valid_bonded_port_id(bonded_port_id) != 0)
701 internals = rte_eth_devices[bonded_port_id].data->dev_private;
703 return internals->balance_xmit_policy;
707 rte_eth_bond_link_monitoring_set(uint16_t bonded_port_id, uint32_t internal_ms)
709 struct bond_dev_private *internals;
711 if (valid_bonded_port_id(bonded_port_id) != 0)
714 internals = rte_eth_devices[bonded_port_id].data->dev_private;
715 internals->link_status_polling_interval_ms = internal_ms;
721 rte_eth_bond_link_monitoring_get(uint16_t bonded_port_id)
723 struct bond_dev_private *internals;
725 if (valid_bonded_port_id(bonded_port_id) != 0)
728 internals = rte_eth_devices[bonded_port_id].data->dev_private;
730 return internals->link_status_polling_interval_ms;
734 rte_eth_bond_link_down_prop_delay_set(uint16_t bonded_port_id,
738 struct bond_dev_private *internals;
740 if (valid_bonded_port_id(bonded_port_id) != 0)
743 internals = rte_eth_devices[bonded_port_id].data->dev_private;
744 internals->link_down_delay_ms = delay_ms;
750 rte_eth_bond_link_down_prop_delay_get(uint16_t bonded_port_id)
752 struct bond_dev_private *internals;
754 if (valid_bonded_port_id(bonded_port_id) != 0)
757 internals = rte_eth_devices[bonded_port_id].data->dev_private;
759 return internals->link_down_delay_ms;
763 rte_eth_bond_link_up_prop_delay_set(uint16_t bonded_port_id, uint32_t delay_ms)
766 struct bond_dev_private *internals;
768 if (valid_bonded_port_id(bonded_port_id) != 0)
771 internals = rte_eth_devices[bonded_port_id].data->dev_private;
772 internals->link_up_delay_ms = delay_ms;
778 rte_eth_bond_link_up_prop_delay_get(uint16_t bonded_port_id)
780 struct bond_dev_private *internals;
782 if (valid_bonded_port_id(bonded_port_id) != 0)
785 internals = rte_eth_devices[bonded_port_id].data->dev_private;
787 return internals->link_up_delay_ms;