1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015 Intel Corporation
12 #include <rte_cycles.h>
13 #include <sys/queue.h>
15 #include <rte_byteorder.h>
16 #include <rte_common.h>
17 #include <rte_debug.h>
18 #include <rte_ethdev.h>
20 #include <rte_lcore.h>
21 #include <rte_memory.h>
22 #include <rte_bus_vdev.h>
24 #include <rte_string_fns.h>
25 #include <rte_errno.h>
26 #include <rte_eth_bond.h>
30 #define SLAVE_COUNT (4)
32 #define RXTX_RING_SIZE 1024
33 #define RXTX_QUEUE_COUNT 4
35 #define BONDED_DEV_NAME ("net_bonding_rss")
37 #define SLAVE_DEV_NAME_FMT ("net_null%d")
38 #define SLAVE_RXTX_QUEUE_FMT ("rssconf_slave%d_q%d")
40 #define NUM_MBUFS 8191
41 #define MBUF_SIZE (1600 + RTE_PKTMBUF_HEADROOM)
42 #define MBUF_CACHE_SIZE 250
45 #define INVALID_SOCKET_ID (-1)
46 #define INVALID_PORT_ID (0xFF)
47 #define INVALID_BONDING_MODE (-1)
51 struct rte_eth_dev_info dev_info;
53 struct rte_eth_rss_conf rss_conf;
55 struct rte_eth_rss_reta_entry64 reta_conf[512 / RTE_RETA_GROUP_SIZE];
58 struct rte_ring *rxtx_queue[RXTX_QUEUE_COUNT];
61 struct link_bonding_rssconf_unittest_params {
63 struct rte_eth_dev_info bond_dev_info;
64 struct rte_eth_rss_reta_entry64 bond_reta_conf[512 / RTE_RETA_GROUP_SIZE];
65 struct slave_conf slave_ports[SLAVE_COUNT];
67 struct rte_mempool *mbuf_pool;
70 static struct link_bonding_rssconf_unittest_params test_params = {
71 .bond_port_id = INVALID_PORT_ID,
73 [0 ... SLAVE_COUNT - 1] = { .port_id = INVALID_PORT_ID, .is_slave = 0}
79 * Default port configuration with RSS turned off
81 static struct rte_eth_conf default_pmd_conf = {
83 .mq_mode = ETH_MQ_RX_NONE,
84 .max_rx_pkt_len = RTE_ETHER_MAX_LEN,
88 .mq_mode = ETH_MQ_TX_NONE,
93 static struct rte_eth_conf rss_pmd_conf = {
95 .mq_mode = ETH_MQ_RX_RSS,
96 .max_rx_pkt_len = RTE_ETHER_MAX_LEN,
100 .mq_mode = ETH_MQ_TX_NONE,
105 .rss_hf = ETH_RSS_IPV6,
111 #define FOR_EACH(_i, _item, _array, _size) \
112 for (_i = 0, _item = &_array[0]; _i < _size && (_item = &_array[_i]); _i++)
114 /* Macro for iterating over every port that can be used as a slave
116 * _i variable used as an index in test_params->slave_ports
117 * _slave pointer to &test_params->slave_ports[_idx]
119 #define FOR_EACH_PORT(_i, _port) \
120 FOR_EACH(_i, _port, test_params.slave_ports, \
121 RTE_DIM(test_params.slave_ports))
124 configure_ethdev(uint16_t port_id, struct rte_eth_conf *eth_conf,
129 TEST_ASSERT(rte_eth_dev_configure(port_id, RXTX_QUEUE_COUNT,
130 RXTX_QUEUE_COUNT, eth_conf) == 0, "Failed to configure device %u",
133 for (rxq = 0; rxq < RXTX_QUEUE_COUNT; rxq++) {
134 TEST_ASSERT(rte_eth_rx_queue_setup(port_id, rxq, RXTX_RING_SIZE,
135 rte_eth_dev_socket_id(port_id), NULL,
136 test_params.mbuf_pool) == 0, "Failed to setup rx queue.");
139 for (txq = 0; txq < RXTX_QUEUE_COUNT; txq++) {
140 TEST_ASSERT(rte_eth_tx_queue_setup(port_id, txq, RXTX_RING_SIZE,
141 rte_eth_dev_socket_id(port_id), NULL) == 0,
142 "Failed to setup tx queue.");
146 TEST_ASSERT(rte_eth_dev_start(port_id) == 0,
147 "Failed to start device (%d).", port_id);
154 * Remove all slaves from bonding
160 struct slave_conf *port;
162 FOR_EACH_PORT(n, port) {
163 port = &test_params.slave_ports[n];
164 if (port->is_slave) {
165 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_remove(
166 test_params.bond_port_id, port->port_id),
167 "Cannot remove slave %d from bonding", port->port_id);
176 remove_slaves_and_stop_bonded_device(void)
178 TEST_ASSERT_SUCCESS(remove_slaves(), "Removing slaves");
179 rte_eth_dev_stop(test_params.bond_port_id);
184 * Add all slaves to bonding
190 struct slave_conf *port;
192 FOR_EACH_PORT(n, port) {
193 port = &test_params.slave_ports[n];
194 if (!port->is_slave) {
195 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_add(test_params.bond_port_id,
196 port->port_id), "Cannot attach slave %d to the bonding",
206 * Set all RETA values in port_id to value
209 reta_set(uint16_t port_id, uint8_t value, int reta_size)
211 struct rte_eth_rss_reta_entry64 reta_conf[512/RTE_RETA_GROUP_SIZE];
214 for (i = 0; i < reta_size / RTE_RETA_GROUP_SIZE; i++) {
215 /* select all fields to set */
216 reta_conf[i].mask = ~0LL;
217 for (j = 0; j < RTE_RETA_GROUP_SIZE; j++)
218 reta_conf[i].reta[j] = value;
221 return rte_eth_dev_rss_reta_update(port_id, reta_conf, reta_size);
225 * Check if slaves RETA is synchronized with bonding port. Returns 1 if slave
226 * port is synced with bonding port.
229 reta_check_synced(struct slave_conf *port)
233 for (i = 0; i < test_params.bond_dev_info.reta_size;
236 int index = i / RTE_RETA_GROUP_SIZE;
237 int shift = i % RTE_RETA_GROUP_SIZE;
239 if (port->reta_conf[index].reta[shift] !=
240 test_params.bond_reta_conf[index].reta[shift])
249 * Fetch bonding ports RETA
252 bond_reta_fetch(void) {
255 for (j = 0; j < test_params.bond_dev_info.reta_size / RTE_RETA_GROUP_SIZE;
257 test_params.bond_reta_conf[j].mask = ~0LL;
259 TEST_ASSERT_SUCCESS(rte_eth_dev_rss_reta_query(test_params.bond_port_id,
260 test_params.bond_reta_conf, test_params.bond_dev_info.reta_size),
261 "Cannot take bonding ports RSS configuration");
269 slave_reta_fetch(struct slave_conf *port) {
272 for (j = 0; j < port->dev_info.reta_size / RTE_RETA_GROUP_SIZE; j++)
273 port->reta_conf[j].mask = ~0LL;
275 TEST_ASSERT_SUCCESS(rte_eth_dev_rss_reta_query(port->port_id,
276 port->reta_conf, port->dev_info.reta_size),
277 "Cannot take bonding ports RSS configuration");
282 * Remove and add slave to check if slaves configuration is synced with
283 * the bonding ports values after adding new slave.
286 slave_remove_and_add(void)
288 struct slave_conf *port = &(test_params.slave_ports[0]);
290 /* 1. Remove first slave from bonding */
291 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_remove(test_params.bond_port_id,
292 port->port_id), "Cannot remove slave #d from bonding");
294 /* 2. Change removed (ex-)slave and bonding configuration to different
297 reta_set(test_params.bond_port_id, 1, test_params.bond_dev_info.reta_size);
300 reta_set(port->port_id, 2, port->dev_info.reta_size);
301 slave_reta_fetch(port);
303 TEST_ASSERT(reta_check_synced(port) == 0,
304 "Removed slave didn't should be synchronized with bonding port");
306 /* 3. Add (ex-)slave and check if configuration changed*/
307 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_add(test_params.bond_port_id,
308 port->port_id), "Cannot add slave");
311 slave_reta_fetch(port);
313 return reta_check_synced(port);
317 * Test configuration propagation over slaves.
324 struct slave_conf *port;
325 uint8_t bond_rss_key[40];
326 struct rte_eth_rss_conf bond_rss_conf;
330 uint64_t default_rss_hf = 0;
332 retval = rte_eth_dev_info_get(test_params.bond_port_id,
333 &test_params.bond_dev_info);
334 TEST_ASSERT((retval == 0),
335 "Error during getting device (port %u) info: %s\n",
336 test_params.bond_port_id, strerror(-retval));
339 * Test hash function propagation
341 for (i = 0; i < sizeof(test_params.bond_dev_info.flow_type_rss_offloads)*8;
344 rss_hf = test_params.bond_dev_info.flow_type_rss_offloads & (1<<i);
346 bond_rss_conf.rss_key = NULL;
347 bond_rss_conf.rss_hf = rss_hf;
349 retval = rte_eth_dev_rss_hash_update(test_params.bond_port_id,
351 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves hash function");
353 FOR_EACH_PORT(n, port) {
354 port = &test_params.slave_ports[n];
356 retval = rte_eth_dev_rss_hash_conf_get(port->port_id,
358 TEST_ASSERT_SUCCESS(retval,
359 "Cannot take slaves RSS configuration");
361 TEST_ASSERT(port->rss_conf.rss_hf == rss_hf,
362 "Hash function not propagated for slave %d",
366 default_rss_hf = rss_hf;
372 * Test key propagation
374 for (i = 1; i < 10; i++) {
376 /* Set all keys to zero */
377 FOR_EACH_PORT(n, port) {
378 port = &test_params.slave_ports[n];
379 memset(port->rss_conf.rss_key, 0, 40);
380 retval = rte_eth_dev_rss_hash_update(port->port_id,
382 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves RSS keys");
385 memset(bond_rss_key, i, sizeof(bond_rss_key));
386 bond_rss_conf.rss_hf = default_rss_hf,
387 bond_rss_conf.rss_key = bond_rss_key;
388 bond_rss_conf.rss_key_len = 40;
390 retval = rte_eth_dev_rss_hash_update(test_params.bond_port_id,
392 TEST_ASSERT_SUCCESS(retval, "Cannot set bonded port RSS keys");
394 FOR_EACH_PORT(n, port) {
395 port = &test_params.slave_ports[n];
397 retval = rte_eth_dev_rss_hash_conf_get(port->port_id,
400 TEST_ASSERT_SUCCESS(retval,
401 "Cannot take slaves RSS configuration");
404 retval = memcmp(port->rss_conf.rss_key, bond_rss_key,
405 sizeof(bond_rss_key));
406 TEST_ASSERT(retval == 0, "Key value not propagated for slave %d",
412 * Test RETA propagation
414 for (i = 0; i < RXTX_QUEUE_COUNT; i++) {
416 /* Set all keys to zero */
417 FOR_EACH_PORT(n, port) {
418 port = &test_params.slave_ports[n];
419 retval = reta_set(port->port_id, (i + 1) % RXTX_QUEUE_COUNT,
420 port->dev_info.reta_size);
421 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves RETA");
424 TEST_ASSERT_SUCCESS(reta_set(test_params.bond_port_id,
425 i % RXTX_QUEUE_COUNT, test_params.bond_dev_info.reta_size),
426 "Cannot set bonded port RETA");
430 FOR_EACH_PORT(n, port) {
431 port = &test_params.slave_ports[n];
433 slave_reta_fetch(port);
434 TEST_ASSERT(reta_check_synced(port) == 1, "RETAs inconsistent");
442 * Test propagation logic, when RX_RSS mq_mode is turned on for bonding port
448 * Configure bonding port in RSS mq mode
452 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
453 &rss_pmd_conf, 0), "Failed to configure bonding device\n");
455 ret = rte_eth_dev_info_get(test_params.bond_port_id,
456 &test_params.bond_dev_info);
457 TEST_ASSERT((ret == 0),
458 "Error during getting device (port %u) info: %s\n",
459 test_params.bond_port_id, strerror(-ret));
461 TEST_ASSERT_SUCCESS(bond_slaves(), "Bonding slaves failed");
463 TEST_ASSERT_SUCCESS(rte_eth_dev_start(test_params.bond_port_id),
464 "Failed to start bonding port (%d).", test_params.bond_port_id);
466 TEST_ASSERT_SUCCESS(test_propagate(), "Propagation test failed");
468 TEST_ASSERT(slave_remove_and_add() == 1, "New slave should be synced");
470 remove_slaves_and_stop_bonded_device();
476 * Test propagation logic, when RX_RSS mq_mode is turned off for bonding port
483 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
484 &default_pmd_conf, 0), "Failed to configure bonding device\n");
486 ret = rte_eth_dev_info_get(test_params.bond_port_id,
487 &test_params.bond_dev_info);
488 TEST_ASSERT((ret == 0),
489 "Error during getting device (port %u) info: %s\n",
490 test_params.bond_port_id, strerror(-ret));
492 TEST_ASSERT_SUCCESS(bond_slaves(), "Bonding slaves failed");
494 TEST_ASSERT_SUCCESS(rte_eth_dev_start(test_params.bond_port_id),
495 "Failed to start bonding port (%d).", test_params.bond_port_id);
497 TEST_ASSERT_SUCCESS(test_propagate(), "Propagation test failed");
499 TEST_ASSERT(slave_remove_and_add() == 0, "New slave shouldn't be synced");
501 remove_slaves_and_stop_bonded_device();
513 struct slave_conf *port;
514 struct rte_ether_addr mac_addr = { .addr_bytes = {0} };
516 if (test_params.mbuf_pool == NULL) {
518 test_params.mbuf_pool = rte_pktmbuf_pool_create(
519 "RSS_MBUF_POOL", NUM_MBUFS * SLAVE_COUNT,
520 MBUF_CACHE_SIZE, 0, MBUF_SIZE, rte_socket_id());
522 TEST_ASSERT(test_params.mbuf_pool != NULL,
523 "rte_pktmbuf_pool_create failed\n");
526 /* Create / initialize ring eth devs. */
527 FOR_EACH_PORT(n, port) {
528 port = &test_params.slave_ports[n];
530 port_id = rte_eth_dev_count_avail();
531 snprintf(name, sizeof(name), SLAVE_DEV_NAME_FMT, port_id);
533 retval = rte_vdev_init(name, "size=64,copy=0");
534 TEST_ASSERT_SUCCESS(retval, "Failed to create null device '%s'\n",
537 port->port_id = port_id;
539 port->rss_conf.rss_key = port->rss_key;
540 port->rss_conf.rss_key_len = 40;
542 retval = configure_ethdev(port->port_id, &default_pmd_conf, 0);
543 TEST_ASSERT_SUCCESS(retval, "Failed to configure virtual ethdev %s\n",
546 /* assign a non-zero MAC */
547 mac_addr.addr_bytes[5] = 0x10 + port->port_id;
548 rte_eth_dev_default_mac_addr_set(port->port_id, &mac_addr);
550 rte_eth_dev_info_get(port->port_id, &port->dev_info);
551 retval = rte_eth_dev_info_get(port->port_id, &port->dev_info);
552 TEST_ASSERT((retval == 0),
553 "Error during getting device (port %u) info: %s\n",
554 test_params.bond_port_id, strerror(-retval));
557 if (test_params.bond_port_id == INVALID_PORT_ID) {
558 retval = rte_eth_bond_create(BONDED_DEV_NAME, 0, rte_socket_id());
560 TEST_ASSERT(retval >= 0, "Failed to create bonded ethdev %s",
563 test_params.bond_port_id = retval;
565 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
566 &default_pmd_conf, 0), "Failed to configure bonding device\n");
568 retval = rte_eth_dev_info_get(test_params.bond_port_id,
569 &test_params.bond_dev_info);
570 TEST_ASSERT((retval == 0),
571 "Error during getting device (port %u) info: %s\n",
572 test_params.bond_port_id, strerror(-retval));
579 testsuite_teardown(void)
581 struct slave_conf *port;
585 * Any cleanup/reset state is done when particular test is
588 rte_eth_dev_stop(test_params.bond_port_id);
590 FOR_EACH_PORT(i, port)
591 rte_eth_dev_stop(port->port_id);
595 check_environment(void)
601 test_rssconf_executor(int (*test_func)(void))
605 /* Check if environment is clean. Fail to launch a test if there was
606 * a critical error before that prevented to reset environment. */
607 TEST_ASSERT_SUCCESS(check_environment(),
608 "Refusing to launch test in dirty environment.");
610 RTE_VERIFY(test_func != NULL);
611 test_result = (*test_func)();
613 /* If test succeed check if environment wast left in good condition. */
614 if (test_result == TEST_SUCCESS)
615 test_result = check_environment();
617 /* Reset environment in case test failed to do that. */
618 if (test_result != TEST_SUCCESS) {
619 TEST_ASSERT_SUCCESS(remove_slaves_and_stop_bonded_device(),
620 "Failed to stop bonded device");
627 test_setup_wrapper(void)
629 return test_rssconf_executor(&test_setup);
633 test_rss_wrapper(void)
635 return test_rssconf_executor(&test_rss);
639 test_rss_lazy_wrapper(void)
641 return test_rssconf_executor(&test_rss_lazy);
644 static struct unit_test_suite link_bonding_rssconf_test_suite = {
645 .suite_name = "RSS Dynamic Configuration for Bonding Unit Test Suite",
646 .teardown = testsuite_teardown,
648 TEST_CASE_NAMED("test_setup", test_setup_wrapper),
649 TEST_CASE_NAMED("test_rss", test_rss_wrapper),
650 TEST_CASE_NAMED("test_rss_lazy", test_rss_lazy_wrapper),
657 test_link_bonding_rssconf(void)
659 return unit_test_suite_runner(&link_bonding_rssconf_test_suite);
662 REGISTER_TEST_COMMAND(link_bonding_rssconf_autotest, test_link_bonding_rssconf);