4 * Copyright(c) 2015 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 #include <rte_cycles.h>
42 #include <sys/queue.h>
44 #include <rte_byteorder.h>
45 #include <rte_common.h>
46 #include <rte_debug.h>
47 #include <rte_ethdev.h>
49 #include <rte_lcore.h>
50 #include <rte_memory.h>
52 #include <rte_string_fns.h>
53 #include <rte_errno.h>
54 #include <rte_eth_bond.h>
58 #define SLAVE_COUNT (4)
60 #define RXTX_RING_SIZE 1024
61 #define RXTX_QUEUE_COUNT 4
63 #define BONDED_DEV_NAME ("net_bonding_rss")
65 #define SLAVE_DEV_NAME_FMT ("net_null%d")
66 #define SLAVE_RXTX_QUEUE_FMT ("rssconf_slave%d_q%d")
68 #define NUM_MBUFS 8191
69 #define MBUF_SIZE (1600 + RTE_PKTMBUF_HEADROOM)
70 #define MBUF_CACHE_SIZE 250
73 #define INVALID_SOCKET_ID (-1)
74 #define INVALID_PORT_ID (0xFF)
75 #define INVALID_BONDING_MODE (-1)
79 struct rte_eth_dev_info dev_info;
81 struct rte_eth_rss_conf rss_conf;
83 struct rte_eth_rss_reta_entry64 reta_conf[512 / RTE_RETA_GROUP_SIZE];
86 struct rte_ring *rxtx_queue[RXTX_QUEUE_COUNT];
89 struct link_bonding_rssconf_unittest_params {
91 struct rte_eth_dev_info bond_dev_info;
92 struct rte_eth_rss_reta_entry64 bond_reta_conf[512 / RTE_RETA_GROUP_SIZE];
93 struct slave_conf slave_ports[SLAVE_COUNT];
95 struct rte_mempool *mbuf_pool;
98 static struct link_bonding_rssconf_unittest_params test_params = {
99 .bond_port_id = INVALID_PORT_ID,
101 [0 ... SLAVE_COUNT - 1] = { .port_id = INVALID_PORT_ID, .is_slave = 0}
107 * Default port configuration with RSS turned off
109 static struct rte_eth_conf default_pmd_conf = {
111 .mq_mode = ETH_MQ_RX_NONE,
112 .max_rx_pkt_len = ETHER_MAX_LEN,
114 .header_split = 0, /**< Header Split disabled */
115 .hw_ip_checksum = 0, /**< IP checksum offload enabled */
116 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
117 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
118 .hw_strip_crc = 1, /**< CRC stripped by hardware */
121 .mq_mode = ETH_MQ_TX_NONE,
126 static struct rte_eth_conf rss_pmd_conf = {
128 .mq_mode = ETH_MQ_RX_RSS,
129 .max_rx_pkt_len = ETHER_MAX_LEN,
131 .header_split = 0, /**< Header Split disabled */
132 .hw_ip_checksum = 0, /**< IP checksum offload enabled */
133 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
134 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
135 .hw_strip_crc = 1, /**< CRC stripped by hardware */
138 .mq_mode = ETH_MQ_TX_NONE,
143 .rss_hf = ETH_RSS_IPV6,
149 #define FOR_EACH(_i, _item, _array, _size) \
150 for (_i = 0, _item = &_array[0]; _i < _size && (_item = &_array[_i]); _i++)
152 /* Macro for iterating over every port that can be used as a slave
154 * _i variable used as an index in test_params->slave_ports
155 * _slave pointer to &test_params->slave_ports[_idx]
157 #define FOR_EACH_PORT(_i, _port) \
158 FOR_EACH(_i, _port, test_params.slave_ports, \
159 RTE_DIM(test_params.slave_ports))
162 configure_ethdev(uint8_t port_id, struct rte_eth_conf *eth_conf, uint8_t start)
166 TEST_ASSERT(rte_eth_dev_configure(port_id, RXTX_QUEUE_COUNT,
167 RXTX_QUEUE_COUNT, eth_conf) == 0, "Failed to configure device %u",
170 for (rxq = 0; rxq < RXTX_QUEUE_COUNT; rxq++) {
171 TEST_ASSERT(rte_eth_rx_queue_setup(port_id, rxq, RXTX_RING_SIZE,
172 rte_eth_dev_socket_id(port_id), NULL,
173 test_params.mbuf_pool) == 0, "Failed to setup rx queue.");
176 for (txq = 0; txq < RXTX_QUEUE_COUNT; txq++) {
177 TEST_ASSERT(rte_eth_tx_queue_setup(port_id, txq, RXTX_RING_SIZE,
178 rte_eth_dev_socket_id(port_id), NULL) == 0,
179 "Failed to setup tx queue.");
183 TEST_ASSERT(rte_eth_dev_start(port_id) == 0,
184 "Failed to start device (%d).", port_id);
191 * Remove all slaves from bonding
197 struct slave_conf *port;
199 FOR_EACH_PORT(n, port) {
200 port = &test_params.slave_ports[n];
201 if (port->is_slave) {
202 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_remove(
203 test_params.bond_port_id, port->port_id),
204 "Cannot remove slave %d from bonding", port->port_id);
213 remove_slaves_and_stop_bonded_device(void)
215 TEST_ASSERT_SUCCESS(remove_slaves(), "Removing slaves");
216 rte_eth_dev_stop(test_params.bond_port_id);
221 * Add all slaves to bonding
227 struct slave_conf *port;
229 FOR_EACH_PORT(n, port) {
230 port = &test_params.slave_ports[n];
231 if (!port->is_slave) {
232 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_add(test_params.bond_port_id,
233 port->port_id), "Cannot attach slave %d to the bonding",
243 * Set all RETA values in port_id to value
246 reta_set(uint8_t port_id, uint8_t value, int reta_size)
248 struct rte_eth_rss_reta_entry64 reta_conf[512/RTE_RETA_GROUP_SIZE];
251 for (i = 0; i < reta_size / RTE_RETA_GROUP_SIZE; i++) {
252 /* select all fields to set */
253 reta_conf[i].mask = ~0LL;
254 for (j = 0; j < RTE_RETA_GROUP_SIZE; j++)
255 reta_conf[i].reta[j] = value;
258 return rte_eth_dev_rss_reta_update(port_id, reta_conf, reta_size);
262 * Check if slaves RETA is synchronized with bonding port. Returns 1 if slave
263 * port is synced with bonding port.
266 reta_check_synced(struct slave_conf *port)
270 for (i = 0; i < test_params.bond_dev_info.reta_size;
273 int index = i / RTE_RETA_GROUP_SIZE;
274 int shift = i % RTE_RETA_GROUP_SIZE;
276 if (port->reta_conf[index].reta[shift] !=
277 test_params.bond_reta_conf[index].reta[shift])
286 * Fetch bonding ports RETA
289 bond_reta_fetch(void) {
292 for (j = 0; j < test_params.bond_dev_info.reta_size / RTE_RETA_GROUP_SIZE;
294 test_params.bond_reta_conf[j].mask = ~0LL;
296 TEST_ASSERT_SUCCESS(rte_eth_dev_rss_reta_query(test_params.bond_port_id,
297 test_params.bond_reta_conf, test_params.bond_dev_info.reta_size),
298 "Cannot take bonding ports RSS configuration");
306 slave_reta_fetch(struct slave_conf *port) {
309 for (j = 0; j < port->dev_info.reta_size / RTE_RETA_GROUP_SIZE; j++)
310 port->reta_conf[j].mask = ~0LL;
312 TEST_ASSERT_SUCCESS(rte_eth_dev_rss_reta_query(port->port_id,
313 port->reta_conf, port->dev_info.reta_size),
314 "Cannot take bonding ports RSS configuration");
319 * Remove and add slave to check if slaves configuration is synced with
320 * the bonding ports values after adding new slave.
323 slave_remove_and_add(void)
325 struct slave_conf *port = &(test_params.slave_ports[0]);
327 /* 1. Remove first slave from bonding */
328 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_remove(test_params.bond_port_id,
329 port->port_id), "Cannot remove slave #d from bonding");
331 /* 2. Change removed (ex-)slave and bonding configuration to different
334 reta_set(test_params.bond_port_id, 1, test_params.bond_dev_info.reta_size);
337 reta_set(port->port_id, 2, port->dev_info.reta_size);
338 slave_reta_fetch(port);
340 TEST_ASSERT(reta_check_synced(port) == 0,
341 "Removed slave didn't should be synchronized with bonding port");
343 /* 3. Add (ex-)slave and check if configuration changed*/
344 TEST_ASSERT_SUCCESS(rte_eth_bond_slave_add(test_params.bond_port_id,
345 port->port_id), "Cannot add slave");
348 slave_reta_fetch(port);
350 return reta_check_synced(port);
354 * Test configuration propagation over slaves.
361 struct slave_conf *port;
362 uint8_t bond_rss_key[40];
363 struct rte_eth_rss_conf bond_rss_conf;
367 uint64_t default_rss_hf = 0;
369 rte_eth_dev_info_get(test_params.bond_port_id, &test_params.bond_dev_info);
372 * Test hash function propagation
374 for (i = 0; i < sizeof(test_params.bond_dev_info.flow_type_rss_offloads)*8;
377 rss_hf = test_params.bond_dev_info.flow_type_rss_offloads & (1<<i);
379 bond_rss_conf.rss_key = NULL;
380 bond_rss_conf.rss_hf = rss_hf;
382 retval = rte_eth_dev_rss_hash_update(test_params.bond_port_id,
384 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves hash function");
386 FOR_EACH_PORT(n, port) {
387 port = &test_params.slave_ports[n];
389 retval = rte_eth_dev_rss_hash_conf_get(port->port_id,
391 TEST_ASSERT_SUCCESS(retval,
392 "Cannot take slaves RSS configuration");
394 TEST_ASSERT(port->rss_conf.rss_hf == rss_hf,
395 "Hash function not propagated for slave %d",
399 default_rss_hf = rss_hf;
405 * Test key propagation
407 for (i = 1; i < 10; i++) {
409 /* Set all keys to zero */
410 FOR_EACH_PORT(n, port) {
411 port = &test_params.slave_ports[n];
412 memset(port->rss_conf.rss_key, 0, 40);
413 retval = rte_eth_dev_rss_hash_update(port->port_id,
415 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves RSS keys");
418 memset(bond_rss_key, i, sizeof(bond_rss_key));
419 bond_rss_conf.rss_hf = default_rss_hf,
420 bond_rss_conf.rss_key = bond_rss_key;
421 bond_rss_conf.rss_key_len = 40;
423 retval = rte_eth_dev_rss_hash_update(test_params.bond_port_id,
425 TEST_ASSERT_SUCCESS(retval, "Cannot set bonded port RSS keys");
427 FOR_EACH_PORT(n, port) {
428 port = &test_params.slave_ports[n];
430 retval = rte_eth_dev_rss_hash_conf_get(port->port_id,
433 TEST_ASSERT_SUCCESS(retval,
434 "Cannot take slaves RSS configuration");
437 retval = memcmp(port->rss_conf.rss_key, bond_rss_key,
438 sizeof(bond_rss_key));
439 TEST_ASSERT(retval == 0, "Key value not propagated for slave %d",
445 * Test RETA propagation
447 for (i = 0; i < RXTX_QUEUE_COUNT; i++) {
449 /* Set all keys to zero */
450 FOR_EACH_PORT(n, port) {
451 port = &test_params.slave_ports[n];
452 retval = reta_set(port->port_id, (i + 1) % RXTX_QUEUE_COUNT,
453 port->dev_info.reta_size);
454 TEST_ASSERT_SUCCESS(retval, "Cannot set slaves RETA");
457 TEST_ASSERT_SUCCESS(reta_set(test_params.bond_port_id,
458 i % RXTX_QUEUE_COUNT, test_params.bond_dev_info.reta_size),
459 "Cannot set bonded port RETA");
463 FOR_EACH_PORT(n, port) {
464 port = &test_params.slave_ports[n];
466 slave_reta_fetch(port);
467 TEST_ASSERT(reta_check_synced(port) == 1, "RETAs inconsistent");
475 * Test propagation logic, when RX_RSS mq_mode is turned on for bonding port
481 * Configure bonding port in RSS mq mode
483 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
484 &rss_pmd_conf, 0), "Failed to configure bonding device\n");
486 rte_eth_dev_info_get(test_params.bond_port_id, &test_params.bond_dev_info);
488 TEST_ASSERT_SUCCESS(bond_slaves(), "Bonding slaves failed");
490 TEST_ASSERT_SUCCESS(rte_eth_dev_start(test_params.bond_port_id),
491 "Failed to start bonding port (%d).", test_params.bond_port_id);
493 TEST_ASSERT_SUCCESS(test_propagate(), "Propagation test failed");
495 TEST_ASSERT(slave_remove_and_add() == 1, "New slave should be synced");
497 remove_slaves_and_stop_bonded_device();
503 * Test propagation logic, when RX_RSS mq_mode is turned off for bonding port
508 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
509 &default_pmd_conf, 0), "Failed to configure bonding device\n");
511 rte_eth_dev_info_get(test_params.bond_port_id, &test_params.bond_dev_info);
513 TEST_ASSERT_SUCCESS(bond_slaves(), "Bonding slaves failed");
515 TEST_ASSERT_SUCCESS(rte_eth_dev_start(test_params.bond_port_id),
516 "Failed to start bonding port (%d).", test_params.bond_port_id);
518 TEST_ASSERT_SUCCESS(test_propagate(), "Propagation test failed");
520 TEST_ASSERT(slave_remove_and_add() == 0, "New slave shouldn't be synced");
522 remove_slaves_and_stop_bonded_device();
534 struct slave_conf *port;
536 if (test_params.mbuf_pool == NULL) {
538 test_params.mbuf_pool = rte_pktmbuf_pool_create(
539 "RSS_MBUF_POOL", NUM_MBUFS * SLAVE_COUNT,
540 MBUF_CACHE_SIZE, 0, MBUF_SIZE, rte_socket_id());
542 TEST_ASSERT(test_params.mbuf_pool != NULL,
543 "rte_pktmbuf_pool_create failed\n");
546 /* Create / initialize ring eth devs. */
547 FOR_EACH_PORT(n, port) {
548 port = &test_params.slave_ports[n];
550 port_id = rte_eth_dev_count();
551 snprintf(name, sizeof(name), SLAVE_DEV_NAME_FMT, port_id);
553 retval = rte_vdev_init(name, "size=64,copy=0");
554 TEST_ASSERT_SUCCESS(retval, "Failed to create null device '%s'\n",
557 port->port_id = port_id;
559 port->rss_conf.rss_key = port->rss_key;
560 port->rss_conf.rss_key_len = 40;
562 retval = configure_ethdev(port->port_id, &default_pmd_conf, 0);
563 TEST_ASSERT_SUCCESS(retval, "Failed to configure virtual ethdev %s\n",
566 rte_eth_dev_info_get(port->port_id, &port->dev_info);
569 if (test_params.bond_port_id == INVALID_PORT_ID) {
570 retval = rte_eth_bond_create(BONDED_DEV_NAME, 0, rte_socket_id());
572 TEST_ASSERT(retval >= 0, "Failed to create bonded ethdev %s",
575 test_params.bond_port_id = retval;
577 TEST_ASSERT_SUCCESS(configure_ethdev(test_params.bond_port_id,
578 &default_pmd_conf, 0), "Failed to configure bonding device\n");
580 rte_eth_dev_info_get(test_params.bond_port_id,
581 &test_params.bond_dev_info);
588 testsuite_teardown(void)
590 struct slave_conf *port;
594 * Any cleanup/reset state is done when particular test is
597 rte_eth_dev_stop(test_params.bond_port_id);
599 FOR_EACH_PORT(i, port)
600 rte_eth_dev_stop(port->port_id);
604 check_environment(void)
610 test_rssconf_executor(int (*test_func)(void))
614 /* Check if environment is clean. Fail to launch a test if there was
615 * a critical error before that prevented to reset environment. */
616 TEST_ASSERT_SUCCESS(check_environment(),
617 "Refusing to launch test in dirty environment.");
619 RTE_VERIFY(test_func != NULL);
620 test_result = (*test_func)();
622 /* If test succeed check if environment wast left in good condition. */
623 if (test_result == TEST_SUCCESS)
624 test_result = check_environment();
626 /* Reset environment in case test failed to do that. */
627 if (test_result != TEST_SUCCESS) {
628 TEST_ASSERT_SUCCESS(remove_slaves_and_stop_bonded_device(),
629 "Failed to stop bonded device");
636 test_setup_wrapper(void)
638 return test_rssconf_executor(&test_setup);
642 test_rss_wrapper(void)
644 return test_rssconf_executor(&test_rss);
648 test_rss_lazy_wrapper(void)
650 return test_rssconf_executor(&test_rss_lazy);
653 static struct unit_test_suite link_bonding_rssconf_test_suite = {
654 .suite_name = "RSS Dynamic Configuration for Bonding Unit Test Suite",
655 .teardown = testsuite_teardown,
657 TEST_CASE_NAMED("test_setup", test_setup_wrapper),
658 TEST_CASE_NAMED("test_rss", test_rss_wrapper),
659 TEST_CASE_NAMED("test_rss_lazy", test_rss_lazy_wrapper),
666 test_link_bonding_rssconf(void)
668 return unit_test_suite_runner(&link_bonding_rssconf_test_suite);
671 REGISTER_TEST_COMMAND(link_bonding_rssconf_autotest, test_link_bonding_rssconf);