4 * Copyright(c) 2010-2014 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.
40 #include <cmdline_parse.h>
45 #include <rte_string_fns.h>
46 #include <rte_mempool.h>
47 #include <rte_ethdev.h>
48 #include <rte_cycles.h>
52 #define MAX_PACKET_SZ 2048
54 (MAX_PACKET_SZ + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
55 #define PKT_BURST_SZ 32
56 #define MEMPOOL_CACHE_SZ PKT_BURST_SZ
60 #define KNI_TIMEOUT_MS 5000 /* ms */
62 #define IFCONFIG "/sbin/ifconfig "
63 #define TEST_KNI_PORT "test_kni_port"
65 /* The threshold number of mbufs to be transmitted or received. */
66 #define KNI_NUM_MBUF_THRESHOLD 100
67 static int kni_pkt_mtu = 0;
69 struct test_kni_stats {
70 volatile uint64_t ingress;
71 volatile uint64_t egress;
74 static const struct rte_eth_rxconf rx_conf = {
83 static const struct rte_eth_txconf tx_conf = {
93 static const struct rte_eth_conf port_conf = {
102 .mq_mode = ETH_DCB_NONE,
106 static struct rte_kni_ops kni_ops = {
108 .config_network_if = NULL,
111 static unsigned lcore_master, lcore_ingress, lcore_egress;
112 static struct rte_kni *test_kni_ctx;
113 static struct test_kni_stats stats;
115 static volatile uint32_t test_kni_processing_flag;
117 static struct rte_mempool *
118 test_kni_create_mempool(void)
120 struct rte_mempool * mp;
122 mp = rte_mempool_lookup("kni_mempool");
124 mp = rte_mempool_create("kni_mempool",
128 sizeof(struct rte_pktmbuf_pool_private),
129 rte_pktmbuf_pool_init,
139 static struct rte_mempool *
140 test_kni_lookup_mempool(void)
142 return rte_mempool_lookup("kni_mempool");
144 /* Callback for request of changing MTU */
146 kni_change_mtu(uint8_t port_id, unsigned new_mtu)
148 printf("Change MTU of port %d to %u\n", port_id, new_mtu);
149 kni_pkt_mtu = new_mtu;
150 printf("Change MTU of port %d to %i successfully.\n",
151 port_id, kni_pkt_mtu);
155 * This loop fully tests the basic functions of KNI. e.g. transmitting,
156 * receiving to, from kernel space, and kernel requests.
158 * This is the loop to transmit/receive mbufs to/from kernel interface with
159 * supported by KNI kernel module. The ingress lcore will allocate mbufs and
160 * transmit them to kernel space; while the egress lcore will receive the mbufs
161 * from kernel space and free them.
162 * On the master lcore, several commands will be run to check handling the
163 * kernel requests. And it will finally set the flag to exit the KNI
164 * transmitting/receiving to/from the kernel space.
166 * Note: To support this testing, the KNI kernel module needs to be insmodded
167 * in one of its loopback modes.
170 test_kni_loop(__rte_unused void *arg)
173 unsigned nb_rx, nb_tx, num, i;
174 const unsigned lcore_id = rte_lcore_id();
175 struct rte_mbuf *pkts_burst[PKT_BURST_SZ];
177 if (lcore_id == lcore_master) {
178 rte_delay_ms(KNI_TIMEOUT_MS);
179 /* tests of handling kernel request */
180 if (system(IFCONFIG TEST_KNI_PORT" up") == -1)
182 if (system(IFCONFIG TEST_KNI_PORT" mtu 1400") == -1)
184 if (system(IFCONFIG TEST_KNI_PORT" down") == -1)
186 rte_delay_ms(KNI_TIMEOUT_MS);
187 test_kni_processing_flag = 1;
188 } else if (lcore_id == lcore_ingress) {
189 struct rte_mempool *mp = test_kni_lookup_mempool();
195 if (test_kni_processing_flag)
198 for (nb_rx = 0; nb_rx < PKT_BURST_SZ; nb_rx++) {
199 pkts_burst[nb_rx] = rte_pktmbuf_alloc(mp);
200 if (!pkts_burst[nb_rx])
204 num = rte_kni_tx_burst(test_kni_ctx, pkts_burst,
206 stats.ingress += num;
207 rte_kni_handle_request(test_kni_ctx);
209 for (i = num; i < nb_rx; i++) {
210 rte_pktmbuf_free(pkts_burst[i]);
215 } else if (lcore_id == lcore_egress) {
217 if (test_kni_processing_flag)
219 num = rte_kni_rx_burst(test_kni_ctx, pkts_burst,
222 for (nb_tx = 0; nb_tx < num; nb_tx++)
223 rte_pktmbuf_free(pkts_burst[nb_tx]);
232 test_kni_allocate_lcores(void)
234 unsigned i, count = 0;
236 lcore_master = rte_get_master_lcore();
237 printf("master lcore: %u\n", lcore_master);
238 for (i = 0; i < RTE_MAX_LCORE; i++) {
241 if (rte_lcore_is_enabled(i) && i != lcore_master) {
249 printf("count: %u\n", count);
251 return (count == 2 ? 0 : -1);
255 test_kni_register_handler_mp(void)
257 #define TEST_KNI_HANDLE_REQ_COUNT 10 /* 5s */
258 #define TEST_KNI_HANDLE_REQ_INTERVAL 500 /* ms */
259 #define TEST_KNI_MTU 1450
260 #define TEST_KNI_MTU_STR " 1450"
265 printf("Failed to fork a process\n");
267 } else if (pid == 0) {
269 struct rte_kni *kni = rte_kni_get(TEST_KNI_PORT);
270 struct rte_kni_ops ops = {
271 .change_mtu = kni_change_mtu,
272 .config_network_if = NULL,
276 printf("Failed to get KNI named %s\n", TEST_KNI_PORT);
282 /* Check with the invalid parameters */
283 if (rte_kni_register_handlers(kni, NULL) == 0) {
284 printf("Unexpectedly register successuflly "
285 "with NULL ops pointer\n");
288 if (rte_kni_register_handlers(NULL, &ops) == 0) {
289 printf("Unexpectedly register successfully "
290 "to NULL KNI device pointer\n");
294 if (rte_kni_register_handlers(kni, &ops)) {
295 printf("Fail to register ops\n");
299 /* Check registering again after it has been registered */
300 if (rte_kni_register_handlers(kni, &ops) == 0) {
301 printf("Unexpectedly register successfully after "
302 "it has already been registered\n");
307 * Handle the request of setting MTU,
308 * with registered handlers.
310 for (i = 0; i < TEST_KNI_HANDLE_REQ_COUNT; i++) {
311 rte_kni_handle_request(kni);
312 if (kni_pkt_mtu == TEST_KNI_MTU)
314 rte_delay_ms(TEST_KNI_HANDLE_REQ_INTERVAL);
316 if (i >= TEST_KNI_HANDLE_REQ_COUNT) {
317 printf("MTU has not been set\n");
322 if (rte_kni_unregister_handlers(kni) < 0) {
323 printf("Fail to unregister ops\n");
327 /* Check with invalid parameter */
328 if (rte_kni_unregister_handlers(NULL) == 0) {
333 * Handle the request of setting MTU,
334 * without registered handlers.
336 for (i = 0; i < TEST_KNI_HANDLE_REQ_COUNT; i++) {
337 rte_kni_handle_request(kni);
338 if (kni_pkt_mtu != 0)
340 rte_delay_ms(TEST_KNI_HANDLE_REQ_INTERVAL);
342 if (kni_pkt_mtu != 0) {
343 printf("MTU shouldn't be set\n");
352 if (system(IFCONFIG TEST_KNI_PORT " mtu" TEST_KNI_MTU_STR)
357 if (system(IFCONFIG TEST_KNI_PORT " mtu" TEST_KNI_MTU_STR)
361 p_ret = wait(&status);
362 if (!WIFEXITED(status)) {
363 printf("Child process (%d) exit abnormally\n", p_ret);
366 if (WEXITSTATUS(status) != 0) {
367 printf("Child process exit with failure\n");
376 test_kni_processing(uint8_t port_id, struct rte_mempool *mp)
381 struct rte_kni_conf conf;
382 struct rte_eth_dev_info info;
383 struct rte_kni_ops ops;
388 memset(&conf, 0, sizeof(conf));
389 memset(&info, 0, sizeof(info));
390 memset(&ops, 0, sizeof(ops));
392 rte_eth_dev_info_get(port_id, &info);
393 conf.addr = info.pci_dev->addr;
394 conf.id = info.pci_dev->id;
395 rte_snprintf(conf.name, sizeof(conf.name), TEST_KNI_PORT);
397 /* core id 1 configured for kernel thread */
400 conf.mbuf_size = MAX_PACKET_SZ;
401 conf.group_id = (uint16_t)port_id;
404 ops.port_id = port_id;
406 /* basic test of kni processing */
407 kni = rte_kni_alloc(mp, &conf, &ops);
409 printf("fail to create kni\n");
412 if (rte_kni_get_port_id(kni) != port_id) {
413 printf("fail to get port id\n");
418 if (rte_kni_info_get(RTE_MAX_ETHPORTS)) {
419 printf("Unexpectedly get a KNI successfully\n");
425 test_kni_processing_flag = 0;
430 * Check multiple processes support on
431 * registerring/unregisterring handlers.
433 if (test_kni_register_handler_mp() < 0) {
434 printf("fail to check multiple process support\n");
439 rte_eal_mp_remote_launch(test_kni_loop, NULL, CALL_MASTER);
440 RTE_LCORE_FOREACH_SLAVE(i) {
441 if (rte_eal_wait_lcore(i) < 0) {
447 * Check if the number of mbufs received from kernel space is equal
448 * to that of transmitted to kernel space
450 if (stats.ingress < KNI_NUM_MBUF_THRESHOLD ||
451 stats.egress < KNI_NUM_MBUF_THRESHOLD) {
452 printf("The ingress/egress number should not be "
453 "less than %u\n", (unsigned)KNI_NUM_MBUF_THRESHOLD);
458 if (rte_kni_release(kni) < 0) {
459 printf("fail to release kni\n");
464 /* test of releasing a released kni device */
465 if (rte_kni_release(kni) == 0) {
466 printf("should not release a released kni device\n");
470 /* test of reusing memzone */
471 kni = rte_kni_alloc(mp, &conf, &ops);
473 printf("fail to create kni\n");
477 /* Release the kni for following testing */
478 if (rte_kni_release(kni) < 0) {
479 printf("fail to release kni\n");
485 if (rte_kni_release(kni) < 0) {
486 printf("fail to release kni\n");
497 uint8_t nb_ports, port_id;
499 struct rte_mempool *mp;
500 struct rte_kni_conf conf;
501 struct rte_eth_dev_info info;
502 struct rte_kni_ops ops;
504 if (test_kni_allocate_lcores() < 0) {
505 printf("No enough lcores for kni processing\n");
509 mp = test_kni_create_mempool();
511 printf("fail to create mempool for kni\n");
514 ret = rte_pmd_init_all();
516 printf("fail to initialize PMD\n");
519 ret = rte_eal_pci_probe();
521 printf("fail to probe PCI devices\n");
525 nb_ports = rte_eth_dev_count();
527 printf("no supported nic port found\n");
531 /* configuring port 0 for the test is enough */
533 ret = rte_eth_dev_configure(port_id, 1, 1, &port_conf);
535 printf("fail to configure port %d\n", port_id);
539 ret = rte_eth_rx_queue_setup(port_id, 0, NB_RXD, SOCKET, &rx_conf, mp);
541 printf("fail to setup rx queue for port %d\n", port_id);
545 ret = rte_eth_tx_queue_setup(port_id, 0, NB_TXD, SOCKET, &tx_conf);
547 printf("fail to setup tx queue for port %d\n", port_id);
551 ret = rte_eth_dev_start(port_id);
553 printf("fail to start port %d\n", port_id);
556 rte_eth_promiscuous_enable(port_id);
558 /* basic test of kni processing */
559 ret = test_kni_processing(port_id, mp);
563 /* test of allocating KNI with NULL mempool pointer */
564 memset(&info, 0, sizeof(info));
565 memset(&conf, 0, sizeof(conf));
566 memset(&ops, 0, sizeof(ops));
567 rte_eth_dev_info_get(port_id, &info);
568 conf.addr = info.pci_dev->addr;
569 conf.id = info.pci_dev->id;
570 conf.group_id = (uint16_t)port_id;
571 conf.mbuf_size = MAX_PACKET_SZ;
574 ops.port_id = port_id;
575 kni = rte_kni_alloc(NULL, &conf, &ops);
578 printf("unexpectedly creates kni successfully with NULL "
579 "mempool pointer\n");
583 /* test of allocating KNI without configurations */
584 kni = rte_kni_alloc(mp, NULL, NULL);
587 printf("Unexpectedly allocate KNI device successfully "
588 "without configurations\n");
592 /* test of allocating KNI without a name */
593 memset(&conf, 0, sizeof(conf));
594 memset(&info, 0, sizeof(info));
595 memset(&ops, 0, sizeof(ops));
596 rte_eth_dev_info_get(port_id, &info);
597 conf.addr = info.pci_dev->addr;
598 conf.id = info.pci_dev->id;
599 conf.group_id = (uint16_t)port_id;
600 conf.mbuf_size = MAX_PACKET_SZ;
603 ops.port_id = port_id;
604 kni = rte_kni_alloc(mp, &conf, &ops);
607 printf("Unexpectedly allocate a KNI device successfully "
612 /* test of getting port id according to NULL kni context */
613 if (rte_kni_get_port_id(NULL) < RTE_MAX_ETHPORTS) {
615 printf("unexpectedly get port id successfully by NULL kni "
620 /* test of releasing NULL kni context */
621 ret = rte_kni_release(NULL);
624 printf("unexpectedly release kni successfully\n");
628 /* test of handling request on NULL device pointer */
629 ret = rte_kni_handle_request(NULL);
632 printf("Unexpectedly handle request on NULL device pointer\n");
636 /* test of getting KNI device with pointer to NULL */
637 kni = rte_kni_get(NULL);
640 printf("Unexpectedly get a KNI device with "
641 "NULL name pointer\n");
645 /* test of getting KNI device with an zero length name string */
646 memset(&conf, 0, sizeof(conf));
647 kni = rte_kni_get(conf.name);
650 printf("Unexpectedly get a KNI device with "
651 "zero length name string\n");
655 /* test of getting KNI device with an invalid string name */
656 memset(&conf, 0, sizeof(conf));
657 rte_snprintf(conf.name, sizeof(conf.name), "testing");
658 kni = rte_kni_get(conf.name);
661 printf("Unexpectedly get a KNI device with "
662 "a never used name string\n");
666 /* test the interface of creating a KNI, for backward compatibility */
667 memset(&ops, 0, sizeof(ops));
669 kni = rte_kni_create(port_id, MAX_PACKET_SZ, mp, &ops);
672 printf("Fail to create a KNI device for port %d\n", port_id);
676 ret = rte_kni_release(kni);
678 printf("Fail to release a KNI device\n");
685 rte_eth_dev_stop(port_id);
690 #else /* RTE_LIBRTE_KNI */
695 printf("The KNI library is not included in this build\n");
699 #endif /* RTE_LIBRTE_KNI */