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.offloads &
198 DEV_RX_OFFLOAD_VLAN_FILTER) == 0)
201 internals = bonded_eth_dev->data->dev_private;
202 found = rte_bitmap_scan(internals->vlan_filter_bmp, &pos, &slab);
212 for (i = 0, mask = 1;
213 i < RTE_BITMAP_SLAB_BIT_SIZE;
215 if (unlikely(slab & mask)) {
216 uint16_t vlan_id = pos + i;
218 res = rte_eth_dev_vlan_filter(slave_port_id,
222 found = rte_bitmap_scan(internals->vlan_filter_bmp,
224 } while (found && first != pos && res == 0);
230 __eth_bond_slave_add_lock_free(uint16_t bonded_port_id, uint16_t slave_port_id)
232 struct rte_eth_dev *bonded_eth_dev, *slave_eth_dev;
233 struct bond_dev_private *internals;
234 struct rte_eth_link link_props;
235 struct rte_eth_dev_info dev_info;
237 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
238 internals = bonded_eth_dev->data->dev_private;
240 if (valid_slave_port_id(slave_port_id, internals->mode) != 0)
243 slave_eth_dev = &rte_eth_devices[slave_port_id];
244 if (slave_eth_dev->data->dev_flags & RTE_ETH_DEV_BONDED_SLAVE) {
245 RTE_BOND_LOG(ERR, "Slave device is already a slave of a bonded device");
249 rte_eth_dev_info_get(slave_port_id, &dev_info);
250 if (dev_info.max_rx_pktlen < internals->max_rx_pktlen) {
251 RTE_BOND_LOG(ERR, "Slave (port %u) max_rx_pktlen too small",
256 slave_add(internals, slave_eth_dev);
258 /* We need to store slaves reta_size to be able to synchronize RETA for all
259 * slave devices even if its sizes are different.
261 internals->slaves[internals->slave_count].reta_size = dev_info.reta_size;
263 if (internals->slave_count < 1) {
264 /* if MAC is not user defined then use MAC of first slave add to
266 if (!internals->user_defined_mac) {
267 if (mac_address_set(bonded_eth_dev,
268 slave_eth_dev->data->mac_addrs)) {
269 RTE_BOND_LOG(ERR, "Failed to set MAC address");
274 /* Inherit eth dev link properties from first slave */
275 link_properties_set(bonded_eth_dev,
276 &(slave_eth_dev->data->dev_link));
278 /* Make primary slave */
279 internals->primary_port = slave_port_id;
280 internals->current_primary_port = slave_port_id;
282 /* Inherit queues settings from first slave */
283 internals->nb_rx_queues = slave_eth_dev->data->nb_rx_queues;
284 internals->nb_tx_queues = slave_eth_dev->data->nb_tx_queues;
286 internals->reta_size = dev_info.reta_size;
288 /* Take the first dev's offload capabilities */
289 internals->rx_offload_capa = dev_info.rx_offload_capa;
290 internals->tx_offload_capa = dev_info.tx_offload_capa;
291 internals->rx_queue_offload_capa = dev_info.rx_queue_offload_capa;
292 internals->tx_queue_offload_capa = dev_info.tx_queue_offload_capa;
293 internals->flow_type_rss_offloads = dev_info.flow_type_rss_offloads;
295 /* Inherit first slave's max rx packet size */
296 internals->candidate_max_rx_pktlen = dev_info.max_rx_pktlen;
299 internals->rx_offload_capa &= dev_info.rx_offload_capa;
300 internals->tx_offload_capa &= dev_info.tx_offload_capa;
301 internals->rx_queue_offload_capa &= dev_info.rx_queue_offload_capa;
302 internals->tx_queue_offload_capa &= dev_info.tx_queue_offload_capa;
303 internals->flow_type_rss_offloads &= dev_info.flow_type_rss_offloads;
305 if (link_properties_valid(bonded_eth_dev,
306 &slave_eth_dev->data->dev_link) != 0) {
307 RTE_BOND_LOG(ERR, "Invalid link properties for slave %d"
308 " in bonding mode %d", slave_port_id,
313 /* RETA size is GCD of all slaves RETA sizes, so, if all sizes will be
314 * the power of 2, the lower one is GCD
316 if (internals->reta_size > dev_info.reta_size)
317 internals->reta_size = dev_info.reta_size;
319 if (!internals->max_rx_pktlen &&
320 dev_info.max_rx_pktlen < internals->candidate_max_rx_pktlen)
321 internals->candidate_max_rx_pktlen = dev_info.max_rx_pktlen;
324 bonded_eth_dev->data->dev_conf.rx_adv_conf.rss_conf.rss_hf &=
325 internals->flow_type_rss_offloads;
327 internals->slave_count++;
329 if (bonded_eth_dev->data->dev_started) {
330 if (slave_configure(bonded_eth_dev, slave_eth_dev) != 0) {
331 internals->slave_count--;
332 RTE_BOND_LOG(ERR, "rte_bond_slaves_configure: port=%d",
338 /* Add slave details to bonded device */
339 slave_eth_dev->data->dev_flags |= RTE_ETH_DEV_BONDED_SLAVE;
341 /* Update all slave devices MACs*/
342 mac_address_slaves_update(bonded_eth_dev);
344 /* Register link status change callback with bonded device pointer as
346 rte_eth_dev_callback_register(slave_port_id, RTE_ETH_EVENT_INTR_LSC,
347 bond_ethdev_lsc_event_callback, &bonded_eth_dev->data->port_id);
349 /* If bonded device is started then we can add the slave to our active
351 if (bonded_eth_dev->data->dev_started) {
352 rte_eth_link_get_nowait(slave_port_id, &link_props);
354 if (link_props.link_status == ETH_LINK_UP) {
355 if (internals->active_slave_count == 0 &&
356 !internals->user_defined_primary_port)
357 bond_ethdev_primary_set(internals,
360 if (find_slave_by_id(internals->active_slaves,
361 internals->active_slave_count,
362 slave_port_id) == internals->active_slave_count)
363 activate_slave(bonded_eth_dev, slave_port_id);
367 slave_vlan_filter_set(bonded_port_id, slave_port_id);
374 rte_eth_bond_slave_add(uint16_t bonded_port_id, uint16_t slave_port_id)
376 struct rte_eth_dev *bonded_eth_dev;
377 struct bond_dev_private *internals;
381 /* Verify that port id's are valid bonded and slave ports */
382 if (valid_bonded_port_id(bonded_port_id) != 0)
385 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
386 internals = bonded_eth_dev->data->dev_private;
388 rte_spinlock_lock(&internals->lock);
390 retval = __eth_bond_slave_add_lock_free(bonded_port_id, slave_port_id);
392 rte_spinlock_unlock(&internals->lock);
398 __eth_bond_slave_remove_lock_free(uint16_t bonded_port_id,
399 uint16_t slave_port_id)
401 struct rte_eth_dev *bonded_eth_dev;
402 struct bond_dev_private *internals;
403 struct rte_eth_dev *slave_eth_dev;
406 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
407 internals = bonded_eth_dev->data->dev_private;
409 if (valid_slave_port_id(slave_port_id, internals->mode) < 0)
412 /* first remove from active slave list */
413 slave_idx = find_slave_by_id(internals->active_slaves,
414 internals->active_slave_count, slave_port_id);
416 if (slave_idx < internals->active_slave_count)
417 deactivate_slave(bonded_eth_dev, slave_port_id);
420 /* now find in slave list */
421 for (i = 0; i < internals->slave_count; i++)
422 if (internals->slaves[i].port_id == slave_port_id) {
428 RTE_BOND_LOG(ERR, "Couldn't find slave in port list, slave count %d",
429 internals->slave_count);
433 /* Un-register link status change callback with bonded device pointer as
435 rte_eth_dev_callback_unregister(slave_port_id, RTE_ETH_EVENT_INTR_LSC,
436 bond_ethdev_lsc_event_callback,
437 &rte_eth_devices[bonded_port_id].data->port_id);
439 /* Restore original MAC address of slave device */
440 rte_eth_dev_default_mac_addr_set(slave_port_id,
441 &(internals->slaves[slave_idx].persisted_mac_addr));
443 slave_eth_dev = &rte_eth_devices[slave_port_id];
444 slave_remove(internals, slave_eth_dev);
445 slave_eth_dev->data->dev_flags &= (~RTE_ETH_DEV_BONDED_SLAVE);
447 /* first slave in the active list will be the primary by default,
448 * otherwise use first device in list */
449 if (internals->current_primary_port == slave_port_id) {
450 if (internals->active_slave_count > 0)
451 internals->current_primary_port = internals->active_slaves[0];
452 else if (internals->slave_count > 0)
453 internals->current_primary_port = internals->slaves[0].port_id;
455 internals->primary_port = 0;
458 if (internals->active_slave_count < 1) {
459 /* if no slaves are any longer attached to bonded device and MAC is not
460 * user defined then clear MAC of bonded device as it will be reset
461 * when a new slave is added */
462 if (internals->slave_count < 1 && !internals->user_defined_mac)
463 memset(rte_eth_devices[bonded_port_id].data->mac_addrs, 0,
464 sizeof(*(rte_eth_devices[bonded_port_id].data->mac_addrs)));
466 if (internals->slave_count == 0) {
467 internals->rx_offload_capa = 0;
468 internals->tx_offload_capa = 0;
469 internals->rx_queue_offload_capa = 0;
470 internals->tx_queue_offload_capa = 0;
471 internals->flow_type_rss_offloads = ETH_RSS_PROTO_MASK;
472 internals->reta_size = 0;
473 internals->candidate_max_rx_pktlen = 0;
474 internals->max_rx_pktlen = 0;
480 rte_eth_bond_slave_remove(uint16_t bonded_port_id, uint16_t slave_port_id)
482 struct rte_eth_dev *bonded_eth_dev;
483 struct bond_dev_private *internals;
486 if (valid_bonded_port_id(bonded_port_id) != 0)
489 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
490 internals = bonded_eth_dev->data->dev_private;
492 rte_spinlock_lock(&internals->lock);
494 retval = __eth_bond_slave_remove_lock_free(bonded_port_id, slave_port_id);
496 rte_spinlock_unlock(&internals->lock);
502 rte_eth_bond_mode_set(uint16_t bonded_port_id, uint8_t mode)
504 struct rte_eth_dev *bonded_eth_dev;
506 if (valid_bonded_port_id(bonded_port_id) != 0)
509 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
511 if (check_for_master_bonded_ethdev(bonded_eth_dev) != 0 &&
512 mode == BONDING_MODE_8023AD)
515 return bond_ethdev_mode_set(bonded_eth_dev, mode);
519 rte_eth_bond_mode_get(uint16_t bonded_port_id)
521 struct bond_dev_private *internals;
523 if (valid_bonded_port_id(bonded_port_id) != 0)
526 internals = rte_eth_devices[bonded_port_id].data->dev_private;
528 return internals->mode;
532 rte_eth_bond_primary_set(uint16_t bonded_port_id, uint16_t slave_port_id)
534 struct bond_dev_private *internals;
536 if (valid_bonded_port_id(bonded_port_id) != 0)
539 internals = rte_eth_devices[bonded_port_id].data->dev_private;
541 if (valid_slave_port_id(slave_port_id, internals->mode) != 0)
544 internals->user_defined_primary_port = 1;
545 internals->primary_port = slave_port_id;
547 bond_ethdev_primary_set(internals, slave_port_id);
553 rte_eth_bond_primary_get(uint16_t bonded_port_id)
555 struct bond_dev_private *internals;
557 if (valid_bonded_port_id(bonded_port_id) != 0)
560 internals = rte_eth_devices[bonded_port_id].data->dev_private;
562 if (internals->slave_count < 1)
565 return internals->current_primary_port;
569 rte_eth_bond_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
572 struct bond_dev_private *internals;
575 if (valid_bonded_port_id(bonded_port_id) != 0)
581 internals = rte_eth_devices[bonded_port_id].data->dev_private;
583 if (internals->slave_count > len)
586 for (i = 0; i < internals->slave_count; i++)
587 slaves[i] = internals->slaves[i].port_id;
589 return internals->slave_count;
593 rte_eth_bond_active_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
596 struct bond_dev_private *internals;
598 if (valid_bonded_port_id(bonded_port_id) != 0)
604 internals = rte_eth_devices[bonded_port_id].data->dev_private;
606 if (internals->active_slave_count > len)
609 memcpy(slaves, internals->active_slaves,
610 internals->active_slave_count * sizeof(internals->active_slaves[0]));
612 return internals->active_slave_count;
616 rte_eth_bond_mac_address_set(uint16_t bonded_port_id,
617 struct ether_addr *mac_addr)
619 struct rte_eth_dev *bonded_eth_dev;
620 struct bond_dev_private *internals;
622 if (valid_bonded_port_id(bonded_port_id) != 0)
625 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
626 internals = bonded_eth_dev->data->dev_private;
628 /* Set MAC Address of Bonded Device */
629 if (mac_address_set(bonded_eth_dev, mac_addr))
632 internals->user_defined_mac = 1;
634 /* Update all slave devices MACs*/
635 if (internals->slave_count > 0)
636 return mac_address_slaves_update(bonded_eth_dev);
642 rte_eth_bond_mac_address_reset(uint16_t bonded_port_id)
644 struct rte_eth_dev *bonded_eth_dev;
645 struct bond_dev_private *internals;
647 if (valid_bonded_port_id(bonded_port_id) != 0)
650 bonded_eth_dev = &rte_eth_devices[bonded_port_id];
651 internals = bonded_eth_dev->data->dev_private;
653 internals->user_defined_mac = 0;
655 if (internals->slave_count > 0) {
656 /* Set MAC Address of Bonded Device */
657 if (mac_address_set(bonded_eth_dev,
658 &internals->slaves[internals->primary_port].persisted_mac_addr)
660 RTE_BOND_LOG(ERR, "Failed to set MAC address on bonded device");
663 /* Update all slave devices MAC addresses */
664 return mac_address_slaves_update(bonded_eth_dev);
666 /* No need to update anything as no slaves present */
671 rte_eth_bond_xmit_policy_set(uint16_t bonded_port_id, uint8_t policy)
673 struct bond_dev_private *internals;
675 if (valid_bonded_port_id(bonded_port_id) != 0)
678 internals = rte_eth_devices[bonded_port_id].data->dev_private;
681 case BALANCE_XMIT_POLICY_LAYER2:
682 internals->balance_xmit_policy = policy;
683 internals->burst_xmit_hash = burst_xmit_l2_hash;
685 case BALANCE_XMIT_POLICY_LAYER23:
686 internals->balance_xmit_policy = policy;
687 internals->burst_xmit_hash = burst_xmit_l23_hash;
689 case BALANCE_XMIT_POLICY_LAYER34:
690 internals->balance_xmit_policy = policy;
691 internals->burst_xmit_hash = burst_xmit_l34_hash;
701 rte_eth_bond_xmit_policy_get(uint16_t bonded_port_id)
703 struct bond_dev_private *internals;
705 if (valid_bonded_port_id(bonded_port_id) != 0)
708 internals = rte_eth_devices[bonded_port_id].data->dev_private;
710 return internals->balance_xmit_policy;
714 rte_eth_bond_link_monitoring_set(uint16_t bonded_port_id, uint32_t internal_ms)
716 struct bond_dev_private *internals;
718 if (valid_bonded_port_id(bonded_port_id) != 0)
721 internals = rte_eth_devices[bonded_port_id].data->dev_private;
722 internals->link_status_polling_interval_ms = internal_ms;
728 rte_eth_bond_link_monitoring_get(uint16_t bonded_port_id)
730 struct bond_dev_private *internals;
732 if (valid_bonded_port_id(bonded_port_id) != 0)
735 internals = rte_eth_devices[bonded_port_id].data->dev_private;
737 return internals->link_status_polling_interval_ms;
741 rte_eth_bond_link_down_prop_delay_set(uint16_t bonded_port_id,
745 struct bond_dev_private *internals;
747 if (valid_bonded_port_id(bonded_port_id) != 0)
750 internals = rte_eth_devices[bonded_port_id].data->dev_private;
751 internals->link_down_delay_ms = delay_ms;
757 rte_eth_bond_link_down_prop_delay_get(uint16_t bonded_port_id)
759 struct bond_dev_private *internals;
761 if (valid_bonded_port_id(bonded_port_id) != 0)
764 internals = rte_eth_devices[bonded_port_id].data->dev_private;
766 return internals->link_down_delay_ms;
770 rte_eth_bond_link_up_prop_delay_set(uint16_t bonded_port_id, uint32_t delay_ms)
773 struct bond_dev_private *internals;
775 if (valid_bonded_port_id(bonded_port_id) != 0)
778 internals = rte_eth_devices[bonded_port_id].data->dev_private;
779 internals->link_up_delay_ms = delay_ms;
785 rte_eth_bond_link_up_prop_delay_get(uint16_t bonded_port_id)
787 struct bond_dev_private *internals;
789 if (valid_bonded_port_id(bonded_port_id) != 0)
792 internals = rte_eth_devices[bonded_port_id].data->dev_private;
794 return internals->link_up_delay_ms;