1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
13 #ifndef RTE_LIBRTE_KNI
18 printf("KNI not supported, skipping test\n");
24 #include <rte_string_fns.h>
25 #include <rte_mempool.h>
26 #include <rte_ethdev.h>
27 #include <rte_bus_pci.h>
28 #include <rte_cycles.h>
32 #define MAX_PACKET_SZ 2048
33 #define MBUF_DATA_SZ (MAX_PACKET_SZ + RTE_PKTMBUF_HEADROOM)
34 #define PKT_BURST_SZ 32
35 #define MEMPOOL_CACHE_SZ PKT_BURST_SZ
39 #define KNI_TIMEOUT_MS 5000 /* ms */
41 #define IFCONFIG "/sbin/ifconfig "
42 #define TEST_KNI_PORT "test_kni_port"
43 #define KNI_TEST_MAX_PORTS 4
44 /* The threshold number of mbufs to be transmitted or received. */
45 #define KNI_NUM_MBUF_THRESHOLD 100
46 static int kni_pkt_mtu = 0;
48 struct test_kni_stats {
49 volatile uint64_t ingress;
50 volatile uint64_t egress;
53 static const struct rte_eth_rxconf rx_conf = {
62 static const struct rte_eth_txconf tx_conf = {
72 static const struct rte_eth_conf port_conf = {
81 .mq_mode = ETH_DCB_NONE,
85 static struct rte_kni_ops kni_ops = {
87 .config_network_if = NULL,
88 .config_mac_address = NULL,
89 .config_promiscusity = NULL,
92 static unsigned lcore_master, lcore_ingress, lcore_egress;
93 static struct rte_kni *test_kni_ctx;
94 static struct test_kni_stats stats;
96 static volatile uint32_t test_kni_processing_flag;
98 static struct rte_mempool *
99 test_kni_create_mempool(void)
101 struct rte_mempool * mp;
103 mp = rte_mempool_lookup("kni_mempool");
105 mp = rte_pktmbuf_pool_create("kni_mempool",
107 MEMPOOL_CACHE_SZ, 0, MBUF_DATA_SZ,
113 static struct rte_mempool *
114 test_kni_lookup_mempool(void)
116 return rte_mempool_lookup("kni_mempool");
118 /* Callback for request of changing MTU */
120 kni_change_mtu(uint16_t port_id, unsigned int new_mtu)
122 printf("Change MTU of port %d to %u\n", port_id, new_mtu);
123 kni_pkt_mtu = new_mtu;
124 printf("Change MTU of port %d to %i successfully.\n",
125 port_id, kni_pkt_mtu);
129 * This loop fully tests the basic functions of KNI. e.g. transmitting,
130 * receiving to, from kernel space, and kernel requests.
132 * This is the loop to transmit/receive mbufs to/from kernel interface with
133 * supported by KNI kernel module. The ingress lcore will allocate mbufs and
134 * transmit them to kernel space; while the egress lcore will receive the mbufs
135 * from kernel space and free them.
136 * On the master lcore, several commands will be run to check handling the
137 * kernel requests. And it will finally set the flag to exit the KNI
138 * transmitting/receiving to/from the kernel space.
140 * Note: To support this testing, the KNI kernel module needs to be insmodded
141 * in one of its loopback modes.
144 test_kni_loop(__rte_unused void *arg)
147 unsigned nb_rx, nb_tx, num, i;
148 const unsigned lcore_id = rte_lcore_id();
149 struct rte_mbuf *pkts_burst[PKT_BURST_SZ];
151 if (lcore_id == lcore_master) {
152 rte_delay_ms(KNI_TIMEOUT_MS);
153 /* tests of handling kernel request */
154 if (system(IFCONFIG TEST_KNI_PORT" up") == -1)
156 if (system(IFCONFIG TEST_KNI_PORT" mtu 1400") == -1)
158 if (system(IFCONFIG TEST_KNI_PORT" down") == -1)
160 rte_delay_ms(KNI_TIMEOUT_MS);
161 test_kni_processing_flag = 1;
162 } else if (lcore_id == lcore_ingress) {
163 struct rte_mempool *mp = test_kni_lookup_mempool();
169 if (test_kni_processing_flag)
172 for (nb_rx = 0; nb_rx < PKT_BURST_SZ; nb_rx++) {
173 pkts_burst[nb_rx] = rte_pktmbuf_alloc(mp);
174 if (!pkts_burst[nb_rx])
178 num = rte_kni_tx_burst(test_kni_ctx, pkts_burst,
180 stats.ingress += num;
181 rte_kni_handle_request(test_kni_ctx);
183 for (i = num; i < nb_rx; i++) {
184 rte_pktmbuf_free(pkts_burst[i]);
189 } else if (lcore_id == lcore_egress) {
191 if (test_kni_processing_flag)
193 num = rte_kni_rx_burst(test_kni_ctx, pkts_burst,
196 for (nb_tx = 0; nb_tx < num; nb_tx++)
197 rte_pktmbuf_free(pkts_burst[nb_tx]);
206 test_kni_allocate_lcores(void)
208 unsigned i, count = 0;
210 lcore_master = rte_get_master_lcore();
211 printf("master lcore: %u\n", lcore_master);
212 for (i = 0; i < RTE_MAX_LCORE; i++) {
215 if (rte_lcore_is_enabled(i) && i != lcore_master) {
223 printf("count: %u\n", count);
225 return count == 2 ? 0 : -1;
229 test_kni_register_handler_mp(void)
231 #define TEST_KNI_HANDLE_REQ_COUNT 10 /* 5s */
232 #define TEST_KNI_HANDLE_REQ_INTERVAL 500 /* ms */
233 #define TEST_KNI_MTU 1450
234 #define TEST_KNI_MTU_STR " 1450"
239 printf("Failed to fork a process\n");
241 } else if (pid == 0) {
243 struct rte_kni *kni = rte_kni_get(TEST_KNI_PORT);
244 struct rte_kni_ops ops = {
245 .change_mtu = kni_change_mtu,
246 .config_network_if = NULL,
247 .config_mac_address = NULL,
248 .config_promiscusity = NULL,
252 printf("Failed to get KNI named %s\n", TEST_KNI_PORT);
258 /* Check with the invalid parameters */
259 if (rte_kni_register_handlers(kni, NULL) == 0) {
260 printf("Unexpectedly register successuflly "
261 "with NULL ops pointer\n");
264 if (rte_kni_register_handlers(NULL, &ops) == 0) {
265 printf("Unexpectedly register successfully "
266 "to NULL KNI device pointer\n");
270 if (rte_kni_register_handlers(kni, &ops)) {
271 printf("Fail to register ops\n");
275 /* Check registering again after it has been registered */
276 if (rte_kni_register_handlers(kni, &ops) == 0) {
277 printf("Unexpectedly register successfully after "
278 "it has already been registered\n");
283 * Handle the request of setting MTU,
284 * with registered handlers.
286 for (i = 0; i < TEST_KNI_HANDLE_REQ_COUNT; i++) {
287 rte_kni_handle_request(kni);
288 if (kni_pkt_mtu == TEST_KNI_MTU)
290 rte_delay_ms(TEST_KNI_HANDLE_REQ_INTERVAL);
292 if (i >= TEST_KNI_HANDLE_REQ_COUNT) {
293 printf("MTU has not been set\n");
298 if (rte_kni_unregister_handlers(kni) < 0) {
299 printf("Fail to unregister ops\n");
303 /* Check with invalid parameter */
304 if (rte_kni_unregister_handlers(NULL) == 0) {
309 * Handle the request of setting MTU,
310 * without registered handlers.
312 for (i = 0; i < TEST_KNI_HANDLE_REQ_COUNT; i++) {
313 rte_kni_handle_request(kni);
314 if (kni_pkt_mtu != 0)
316 rte_delay_ms(TEST_KNI_HANDLE_REQ_INTERVAL);
318 if (kni_pkt_mtu != 0) {
319 printf("MTU shouldn't be set\n");
328 if (system(IFCONFIG TEST_KNI_PORT " mtu" TEST_KNI_MTU_STR)
333 if (system(IFCONFIG TEST_KNI_PORT " mtu" TEST_KNI_MTU_STR)
337 p_ret = wait(&status);
338 if (!WIFEXITED(status)) {
339 printf("Child process (%d) exit abnormally\n", p_ret);
342 if (WEXITSTATUS(status) != 0) {
343 printf("Child process exit with failure\n");
352 test_kni_processing(uint16_t port_id, struct rte_mempool *mp)
357 struct rte_kni_conf conf;
358 struct rte_eth_dev_info info;
359 struct rte_kni_ops ops;
364 memset(&conf, 0, sizeof(conf));
365 memset(&info, 0, sizeof(info));
366 memset(&ops, 0, sizeof(ops));
368 rte_eth_dev_info_get(port_id, &info);
369 conf.addr = info.pci_dev->addr;
370 conf.id = info.pci_dev->id;
371 snprintf(conf.name, sizeof(conf.name), TEST_KNI_PORT);
373 /* core id 1 configured for kernel thread */
376 conf.mbuf_size = MAX_PACKET_SZ;
377 conf.group_id = port_id;
380 ops.port_id = port_id;
382 /* basic test of kni processing */
383 kni = rte_kni_alloc(mp, &conf, &ops);
385 printf("fail to create kni\n");
390 test_kni_processing_flag = 0;
395 * Check multiple processes support on
396 * registerring/unregisterring handlers.
398 if (test_kni_register_handler_mp() < 0) {
399 printf("fail to check multiple process support\n");
404 rte_eal_mp_remote_launch(test_kni_loop, NULL, CALL_MASTER);
405 RTE_LCORE_FOREACH_SLAVE(i) {
406 if (rte_eal_wait_lcore(i) < 0) {
412 * Check if the number of mbufs received from kernel space is equal
413 * to that of transmitted to kernel space
415 if (stats.ingress < KNI_NUM_MBUF_THRESHOLD ||
416 stats.egress < KNI_NUM_MBUF_THRESHOLD) {
417 printf("The ingress/egress number should not be "
418 "less than %u\n", (unsigned)KNI_NUM_MBUF_THRESHOLD);
423 if (rte_kni_release(kni) < 0) {
424 printf("fail to release kni\n");
429 /* test of releasing a released kni device */
430 if (rte_kni_release(kni) == 0) {
431 printf("should not release a released kni device\n");
435 /* test of reusing memzone */
436 kni = rte_kni_alloc(mp, &conf, &ops);
438 printf("fail to create kni\n");
442 /* Release the kni for following testing */
443 if (rte_kni_release(kni) < 0) {
444 printf("fail to release kni\n");
450 if (rte_kni_release(kni) < 0) {
451 printf("fail to release kni\n");
462 uint16_t nb_ports, port_id;
464 struct rte_mempool *mp;
465 struct rte_kni_conf conf;
466 struct rte_eth_dev_info info;
467 struct rte_kni_ops ops;
469 /* Initialize KNI subsytem */
470 rte_kni_init(KNI_TEST_MAX_PORTS);
472 if (test_kni_allocate_lcores() < 0) {
473 printf("No enough lcores for kni processing\n");
477 mp = test_kni_create_mempool();
479 printf("fail to create mempool for kni\n");
483 nb_ports = rte_eth_dev_count();
485 printf("no supported nic port found\n");
489 /* configuring port 0 for the test is enough */
491 ret = rte_eth_dev_configure(port_id, 1, 1, &port_conf);
493 printf("fail to configure port %d\n", port_id);
497 ret = rte_eth_rx_queue_setup(port_id, 0, NB_RXD, SOCKET, &rx_conf, mp);
499 printf("fail to setup rx queue for port %d\n", port_id);
503 ret = rte_eth_tx_queue_setup(port_id, 0, NB_TXD, SOCKET, &tx_conf);
505 printf("fail to setup tx queue for port %d\n", port_id);
509 ret = rte_eth_dev_start(port_id);
511 printf("fail to start port %d\n", port_id);
514 rte_eth_promiscuous_enable(port_id);
516 /* basic test of kni processing */
517 ret = test_kni_processing(port_id, mp);
521 /* test of allocating KNI with NULL mempool pointer */
522 memset(&info, 0, sizeof(info));
523 memset(&conf, 0, sizeof(conf));
524 memset(&ops, 0, sizeof(ops));
525 rte_eth_dev_info_get(port_id, &info);
526 conf.addr = info.pci_dev->addr;
527 conf.id = info.pci_dev->id;
528 conf.group_id = port_id;
529 conf.mbuf_size = MAX_PACKET_SZ;
532 ops.port_id = port_id;
533 kni = rte_kni_alloc(NULL, &conf, &ops);
536 printf("unexpectedly creates kni successfully with NULL "
537 "mempool pointer\n");
541 /* test of allocating KNI without configurations */
542 kni = rte_kni_alloc(mp, NULL, NULL);
545 printf("Unexpectedly allocate KNI device successfully "
546 "without configurations\n");
550 /* test of allocating KNI without a name */
551 memset(&conf, 0, sizeof(conf));
552 memset(&info, 0, sizeof(info));
553 memset(&ops, 0, sizeof(ops));
554 rte_eth_dev_info_get(port_id, &info);
555 conf.addr = info.pci_dev->addr;
556 conf.id = info.pci_dev->id;
557 conf.group_id = port_id;
558 conf.mbuf_size = MAX_PACKET_SZ;
561 ops.port_id = port_id;
562 kni = rte_kni_alloc(mp, &conf, &ops);
565 printf("Unexpectedly allocate a KNI device successfully "
570 /* test of releasing NULL kni context */
571 ret = rte_kni_release(NULL);
574 printf("unexpectedly release kni successfully\n");
578 /* test of handling request on NULL device pointer */
579 ret = rte_kni_handle_request(NULL);
582 printf("Unexpectedly handle request on NULL device pointer\n");
586 /* test of getting KNI device with pointer to NULL */
587 kni = rte_kni_get(NULL);
590 printf("Unexpectedly get a KNI device with "
591 "NULL name pointer\n");
595 /* test of getting KNI device with an zero length name string */
596 memset(&conf, 0, sizeof(conf));
597 kni = rte_kni_get(conf.name);
600 printf("Unexpectedly get a KNI device with "
601 "zero length name string\n");
605 /* test of getting KNI device with an invalid string name */
606 memset(&conf, 0, sizeof(conf));
607 snprintf(conf.name, sizeof(conf.name), "testing");
608 kni = rte_kni_get(conf.name);
611 printf("Unexpectedly get a KNI device with "
612 "a never used name string\n");
618 rte_eth_dev_stop(port_id);
625 REGISTER_TEST_COMMAND(kni_autotest, test_kni);