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 = ETHER_MAX_LEN,
86 .offloads = DEV_RX_OFFLOAD_CRC_STRIP,
89 .mq_mode = ETH_MQ_TX_NONE,
94 static struct rte_eth_conf rss_pmd_conf = {
96 .mq_mode = ETH_MQ_RX_RSS,
97 .max_rx_pkt_len = ETHER_MAX_LEN,
99 .offloads = DEV_RX_OFFLOAD_CRC_STRIP,
102 .mq_mode = ETH_MQ_TX_NONE,
107 .rss_hf = ETH_RSS_IPV6,
113 #define FOR_EACH(_i, _item, _array, _size) \
114 for (_i = 0, _item = &_array[0]; _i < _size && (_item = &_array[_i]); _i++)
116 /* Macro for iterating over every port that can be used as a slave
118 * _i variable used as an index in test_params->slave_ports
119 * _slave pointer to &test_params->slave_ports[_idx]
121 #define FOR_EACH_PORT(_i, _port) \
122 FOR_EACH(_i, _port, test_params.slave_ports, \
123 RTE_DIM(test_params.slave_ports))
126 configure_ethdev(uint16_t port_id, struct rte_eth_conf *eth_conf,
131 TEST_ASSERT(rte_eth_dev_configure(port_id, RXTX_QUEUE_COUNT,
132 RXTX_QUEUE_COUNT, eth_conf) == 0, "Failed to configure device %u",
135 for (rxq = 0; rxq < RXTX_QUEUE_COUNT; rxq++) {
136 TEST_ASSERT(rte_eth_rx_queue_setup(port_id, rxq, RXTX_RING_SIZE,
137 rte_eth_dev_socket_id(port_id), NULL,
138 test_params.mbuf_pool) == 0, "Failed to setup rx queue.");
141 for (txq = 0; txq < RXTX_QUEUE_COUNT; txq++) {
142 TEST_ASSERT(rte_eth_tx_queue_setup(port_id, txq, RXTX_RING_SIZE,
143 rte_eth_dev_socket_id(port_id), NULL) == 0,
144 "Failed to setup tx queue.");
148 TEST_ASSERT(rte_eth_dev_start(port_id) == 0,
149 "Failed to start device (%d).", port_id);
156 * Remove all slaves from bonding
162 struct slave_conf *port;
164 FOR_EACH_PORT(n, port) {
165 port = &test_params.slave_ports[n];
166 if (port->is_slave) {
167 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_remove(
168 test_params.bond_port_id, port->port_id),
169 "Cannot remove slave %d from bonding", port->port_id);
178 remove_slaves_and_stop_bonded_device(void)
180 TEST_ASSERT_SUCCESS(remove_slaves(), "Removing slaves");
181 rte_eth_dev_stop(test_params.bond_port_id);
186 * Add all slaves to bonding
192 struct slave_conf *port;
194 FOR_EACH_PORT(n, port) {
195 port = &test_params.slave_ports[n];
196 if (!port->is_slave) {
197 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_add(test_params.bond_port_id,
198 port->port_id), "Cannot attach slave %d to the bonding",
208 * Set all RETA values in port_id to value
211 reta_set(uint16_t port_id, uint8_t value, int reta_size)
213 struct rte_eth_rss_reta_entry64 reta_conf[512/RTE_RETA_GROUP_SIZE];
216 for (i = 0; i < reta_size / RTE_RETA_GROUP_SIZE; i++) {
217 /* select all fields to set */
218 reta_conf[i].mask = ~0LL;
219 for (j = 0; j < RTE_RETA_GROUP_SIZE; j++)
220 reta_conf[i].reta[j] = value;
223 return rte_eth_dev_rss_reta_update(port_id, reta_conf, reta_size);
227 * Check if slaves RETA is synchronized with bonding port. Returns 1 if slave
228 * port is synced with bonding port.
231 reta_check_synced(struct slave_conf *port)
235 for (i = 0; i < test_params.bond_dev_info.reta_size;
238 int index = i / RTE_RETA_GROUP_SIZE;
239 int shift = i % RTE_RETA_GROUP_SIZE;
241 if (port->reta_conf[index].reta[shift] !=
242 test_params.bond_reta_conf[index].reta[shift])
251 * Fetch bonding ports RETA
254 bond_reta_fetch(void) {
257 for (j = 0; j < test_params.bond_dev_info.reta_size / RTE_RETA_GROUP_SIZE;
259 test_params.bond_reta_conf[j].mask = ~0LL;
261 TEST_ASSERT_SUCCESS(rte_eth_dev_rss_reta_query(test_params.bond_port_id,
262 test_params.bond_reta_conf, test_params.bond_dev_info.reta_size),
263 "Cannot take bonding ports RSS configuration");
271 slave_reta_fetch(struct slave_conf *port) {
274 for (j = 0; j < port->dev_info.reta_size / RTE_RETA_GROUP_SIZE; j++)
275 port->reta_conf[j].mask = ~0LL;
277 TEST_ASSERT_SUCCESS(rte_eth_dev_rss_reta_query(port->port_id,
278 port->reta_conf, port->dev_info.reta_size),
279 "Cannot take bonding ports RSS configuration");
284 * Remove and add slave to check if slaves configuration is synced with
285 * the bonding ports values after adding new slave.
288 slave_remove_and_add(void)
290 struct slave_conf *port = &(test_params.slave_ports[0]);
292 /* 1. Remove first slave from bonding */
293 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_remove(test_params.bond_port_id,
294 port->port_id), "Cannot remove slave #d from bonding");
296 /* 2. Change removed (ex-)slave and bonding configuration to different
299 reta_set(test_params.bond_port_id, 1, test_params.bond_dev_info.reta_size);
302 reta_set(port->port_id, 2, port->dev_info.reta_size);
303 slave_reta_fetch(port);
305 TEST_ASSERT(reta_check_synced(port) == 0,
306 "Removed slave didn't should be synchronized with bonding port");
308 /* 3. Add (ex-)slave and check if configuration changed*/
309 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_add(test_params.bond_port_id,
310 port->port_id), "Cannot add slave");
313 slave_reta_fetch(port);
315 return reta_check_synced(port);
319 * Test configuration propagation over slaves.
326 struct slave_conf *port;
327 uint8_t bond_rss_key[40];
328 struct rte_eth_rss_conf bond_rss_conf;
332 uint64_t default_rss_hf = 0;
334 rte_eth_dev_info_get(test_params.bond_port_id, &test_params.bond_dev_info);
337 * Test hash function propagation
339 for (i = 0; i < sizeof(test_params.bond_dev_info.flow_type_rss_offloads)*8;
342 rss_hf = test_params.bond_dev_info.flow_type_rss_offloads & (1<<i);
344 bond_rss_conf.rss_key = NULL;
345 bond_rss_conf.rss_hf = rss_hf;
347 retval = rte_eth_dev_rss_hash_update(test_params.bond_port_id,
349 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves hash function");
351 FOR_EACH_PORT(n, port) {
352 port = &test_params.slave_ports[n];
354 retval = rte_eth_dev_rss_hash_conf_get(port->port_id,
356 TEST_ASSERT_SUCCESS(retval,
357 "Cannot take slaves RSS configuration");
359 TEST_ASSERT(port->rss_conf.rss_hf == rss_hf,
360 "Hash function not propagated for slave %d",
364 default_rss_hf = rss_hf;
370 * Test key propagation
372 for (i = 1; i < 10; i++) {
374 /* Set all keys to zero */
375 FOR_EACH_PORT(n, port) {
376 port = &test_params.slave_ports[n];
377 memset(port->rss_conf.rss_key, 0, 40);
378 retval = rte_eth_dev_rss_hash_update(port->port_id,
380 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves RSS keys");
383 memset(bond_rss_key, i, sizeof(bond_rss_key));
384 bond_rss_conf.rss_hf = default_rss_hf,
385 bond_rss_conf.rss_key = bond_rss_key;
386 bond_rss_conf.rss_key_len = 40;
388 retval = rte_eth_dev_rss_hash_update(test_params.bond_port_id,
390 TEST_ASSERT_SUCCESS(retval, "Cannot set bonded port RSS keys");
392 FOR_EACH_PORT(n, port) {
393 port = &test_params.slave_ports[n];
395 retval = rte_eth_dev_rss_hash_conf_get(port->port_id,
398 TEST_ASSERT_SUCCESS(retval,
399 "Cannot take slaves RSS configuration");
402 retval = memcmp(port->rss_conf.rss_key, bond_rss_key,
403 sizeof(bond_rss_key));
404 TEST_ASSERT(retval == 0, "Key value not propagated for slave %d",
410 * Test RETA propagation
412 for (i = 0; i < RXTX_QUEUE_COUNT; i++) {
414 /* Set all keys to zero */
415 FOR_EACH_PORT(n, port) {
416 port = &test_params.slave_ports[n];
417 retval = reta_set(port->port_id, (i + 1) % RXTX_QUEUE_COUNT,
418 port->dev_info.reta_size);
419 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves RETA");
422 TEST_ASSERT_SUCCESS(reta_set(test_params.bond_port_id,
423 i % RXTX_QUEUE_COUNT, test_params.bond_dev_info.reta_size),
424 "Cannot set bonded port RETA");
428 FOR_EACH_PORT(n, port) {
429 port = &test_params.slave_ports[n];
431 slave_reta_fetch(port);
432 TEST_ASSERT(reta_check_synced(port) == 1, "RETAs inconsistent");
440 * Test propagation logic, when RX_RSS mq_mode is turned on for bonding port
446 * Configure bonding port in RSS mq mode
448 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
449 &rss_pmd_conf, 0), "Failed to configure bonding device\n");
451 rte_eth_dev_info_get(test_params.bond_port_id, &test_params.bond_dev_info);
453 TEST_ASSERT_SUCCESS(bond_slaves(), "Bonding slaves failed");
455 TEST_ASSERT_SUCCESS(rte_eth_dev_start(test_params.bond_port_id),
456 "Failed to start bonding port (%d).", test_params.bond_port_id);
458 TEST_ASSERT_SUCCESS(test_propagate(), "Propagation test failed");
460 TEST_ASSERT(slave_remove_and_add() == 1, "New slave should be synced");
462 remove_slaves_and_stop_bonded_device();
468 * Test propagation logic, when RX_RSS mq_mode is turned off for bonding port
473 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
474 &default_pmd_conf, 0), "Failed to configure bonding device\n");
476 rte_eth_dev_info_get(test_params.bond_port_id, &test_params.bond_dev_info);
478 TEST_ASSERT_SUCCESS(bond_slaves(), "Bonding slaves failed");
480 TEST_ASSERT_SUCCESS(rte_eth_dev_start(test_params.bond_port_id),
481 "Failed to start bonding port (%d).", test_params.bond_port_id);
483 TEST_ASSERT_SUCCESS(test_propagate(), "Propagation test failed");
485 TEST_ASSERT(slave_remove_and_add() == 0, "New slave shouldn't be synced");
487 remove_slaves_and_stop_bonded_device();
499 struct slave_conf *port;
500 struct ether_addr mac_addr = { .addr_bytes = {0} };
502 if (test_params.mbuf_pool == NULL) {
504 test_params.mbuf_pool = rte_pktmbuf_pool_create(
505 "RSS_MBUF_POOL", NUM_MBUFS * SLAVE_COUNT,
506 MBUF_CACHE_SIZE, 0, MBUF_SIZE, rte_socket_id());
508 TEST_ASSERT(test_params.mbuf_pool != NULL,
509 "rte_pktmbuf_pool_create failed\n");
512 /* Create / initialize ring eth devs. */
513 FOR_EACH_PORT(n, port) {
514 port = &test_params.slave_ports[n];
516 port_id = rte_eth_dev_count_avail();
517 snprintf(name, sizeof(name), SLAVE_DEV_NAME_FMT, port_id);
519 retval = rte_vdev_init(name, "size=64,copy=0");
520 TEST_ASSERT_SUCCESS(retval, "Failed to create null device '%s'\n",
523 port->port_id = port_id;
525 port->rss_conf.rss_key = port->rss_key;
526 port->rss_conf.rss_key_len = 40;
528 retval = configure_ethdev(port->port_id, &default_pmd_conf, 0);
529 TEST_ASSERT_SUCCESS(retval, "Failed to configure virtual ethdev %s\n",
532 /* assign a non-zero MAC */
533 mac_addr.addr_bytes[5] = 0x10 + port->port_id;
534 rte_eth_dev_default_mac_addr_set(port->port_id, &mac_addr);
536 rte_eth_dev_info_get(port->port_id, &port->dev_info);
539 if (test_params.bond_port_id == INVALID_PORT_ID) {
540 retval = rte_eth_bond_create(BONDED_DEV_NAME, 0, rte_socket_id());
542 TEST_ASSERT(retval >= 0, "Failed to create bonded ethdev %s",
545 test_params.bond_port_id = retval;
547 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
548 &default_pmd_conf, 0), "Failed to configure bonding device\n");
550 rte_eth_dev_info_get(test_params.bond_port_id,
551 &test_params.bond_dev_info);
558 testsuite_teardown(void)
560 struct slave_conf *port;
564 * Any cleanup/reset state is done when particular test is
567 rte_eth_dev_stop(test_params.bond_port_id);
569 FOR_EACH_PORT(i, port)
570 rte_eth_dev_stop(port->port_id);
574 check_environment(void)
580 test_rssconf_executor(int (*test_func)(void))
584 /* Check if environment is clean. Fail to launch a test if there was
585 * a critical error before that prevented to reset environment. */
586 TEST_ASSERT_SUCCESS(check_environment(),
587 "Refusing to launch test in dirty environment.");
589 RTE_VERIFY(test_func != NULL);
590 test_result = (*test_func)();
592 /* If test succeed check if environment wast left in good condition. */
593 if (test_result == TEST_SUCCESS)
594 test_result = check_environment();
596 /* Reset environment in case test failed to do that. */
597 if (test_result != TEST_SUCCESS) {
598 TEST_ASSERT_SUCCESS(remove_slaves_and_stop_bonded_device(),
599 "Failed to stop bonded device");
606 test_setup_wrapper(void)
608 return test_rssconf_executor(&test_setup);
612 test_rss_wrapper(void)
614 return test_rssconf_executor(&test_rss);
618 test_rss_lazy_wrapper(void)
620 return test_rssconf_executor(&test_rss_lazy);
623 static struct unit_test_suite link_bonding_rssconf_test_suite = {
624 .suite_name = "RSS Dynamic Configuration for Bonding Unit Test Suite",
625 .teardown = testsuite_teardown,
627 TEST_CASE_NAMED("test_setup", test_setup_wrapper),
628 TEST_CASE_NAMED("test_rss", test_rss_wrapper),
629 TEST_CASE_NAMED("test_rss_lazy", test_rss_lazy_wrapper),
636 test_link_bonding_rssconf(void)
638 return unit_test_suite_runner(&link_bonding_rssconf_test_suite);
641 REGISTER_TEST_COMMAND(link_bonding_rssconf_autotest, test_link_bonding_rssconf);