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.
39 #include <sys/queue.h>
44 #include <netinet/in.h>
46 #ifdef RTE_EXEC_ENV_LINUXAPP
47 #include <linux/if_tun.h>
50 #include <sys/ioctl.h>
54 #include <rte_common.h>
56 #include <rte_memory.h>
57 #include <rte_memcpy.h>
59 #include <rte_per_lcore.h>
60 #include <rte_launch.h>
61 #include <rte_atomic.h>
62 #include <rte_lcore.h>
63 #include <rte_branch_prediction.h>
64 #include <rte_interrupts.h>
65 #include <rte_debug.h>
66 #include <rte_ether.h>
67 #include <rte_ethdev.h>
68 #include <rte_mempool.h>
70 #include <rte_string_fns.h>
71 #include <rte_cycles.h>
73 /* Macros for printing using RTE_LOG */
74 #define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1
75 #define FATAL_ERROR(fmt, args...) rte_exit(EXIT_FAILURE, fmt "\n", ##args)
76 #define PRINT_INFO(fmt, args...) RTE_LOG(INFO, APP, fmt "\n", ##args)
78 /* Max ports than can be used (each port is associated with two lcores) */
79 #define MAX_PORTS (RTE_MAX_LCORE / 2)
81 /* Max size of a single packet */
82 #define MAX_PACKET_SZ (2048)
84 /* Size of the data buffer in each mbuf */
85 #define MBUF_DATA_SZ (MAX_PACKET_SZ + RTE_PKTMBUF_HEADROOM)
87 /* Number of mbufs in mempool that is created */
90 /* How many packets to attempt to read from NIC in one go */
91 #define PKT_BURST_SZ 32
93 /* How many objects (mbufs) to keep in per-lcore mempool cache */
94 #define MEMPOOL_CACHE_SZ PKT_BURST_SZ
96 /* Number of RX ring descriptors */
99 /* Number of TX ring descriptors */
103 * RX and TX Prefetch, Host, and Write-back threshold values should be
104 * carefully set for optimal performance. Consult the network
105 * controller's datasheet and supporting DPDK documentation for guidance
106 * on how these parameters should be set.
109 /* Options for configuring ethernet port */
110 static const struct rte_eth_conf port_conf = {
112 .header_split = 0, /* Header Split disabled */
113 .hw_ip_checksum = 0, /* IP checksum offload disabled */
114 .hw_vlan_filter = 0, /* VLAN filtering disabled */
115 .jumbo_frame = 0, /* Jumbo Frame Support disabled */
116 .hw_strip_crc = 1, /* CRC stripped by hardware */
119 .mq_mode = ETH_MQ_TX_NONE,
123 /* Mempool for mbufs */
124 static struct rte_mempool * pktmbuf_pool = NULL;
126 /* Mask of enabled ports */
127 static uint32_t ports_mask = 0;
129 /* Mask of cores that read from NIC and write to tap */
130 static uint64_t input_cores_mask = 0;
132 /* Mask of cores that read from tap and write to NIC */
133 static uint64_t output_cores_mask = 0;
135 /* Array storing port_id that is associated with each lcore */
136 static uint16_t port_ids[RTE_MAX_LCORE];
138 /* Structure type for recording lcore-specific stats */
145 /* Array of lcore-specific stats */
146 static struct stats lcore_stats[RTE_MAX_LCORE];
148 /* Print out statistics on packets handled */
154 printf("\n**Exception-Path example application statistics**\n"
155 "======= ====== ============ ============ ===============\n"
156 " Lcore Port RX TX Dropped on TX\n"
157 "------- ------ ------------ ------------ ---------------\n");
158 RTE_LCORE_FOREACH(i) {
159 printf("%6u %7u %13"PRIu64" %13"PRIu64" %16"PRIu64"\n",
160 i, (unsigned)port_ids[i],
161 lcore_stats[i].rx, lcore_stats[i].tx,
162 lcore_stats[i].dropped);
164 printf("======= ====== ============ ============ ===============\n");
167 /* Custom handling of signals to handle stats */
169 signal_handler(int signum)
171 /* When we receive a USR1 signal, print stats */
172 if (signum == SIGUSR1) {
176 /* When we receive a USR2 signal, reset stats */
177 if (signum == SIGUSR2) {
178 memset(&lcore_stats, 0, sizeof(lcore_stats));
179 printf("\n**Statistics have been reset**\n");
184 #ifdef RTE_EXEC_ENV_LINUXAPP
186 * Create a tap network interface, or use existing one with same name.
187 * If name[0]='\0' then a name is automatically assigned and returned in name.
189 static int tap_create(char *name)
194 fd = open("/dev/net/tun", O_RDWR);
198 memset(&ifr, 0, sizeof(ifr));
200 /* TAP device without packet information */
201 ifr.ifr_flags = IFF_TAP | IFF_NO_PI;
204 snprintf(ifr.ifr_name, IFNAMSIZ, "%s", name);
206 ret = ioctl(fd, TUNSETIFF, (void *) &ifr);
213 snprintf(name, IFNAMSIZ, "%s", ifr.ifr_name);
219 * Find a free tap network interface, or create a new one.
220 * The name is automatically assigned and returned in name.
222 static int tap_create(char *name)
225 char devname[PATH_MAX];
227 for (i = 0; i < 255; i++) {
228 snprintf(devname, sizeof(devname), "/dev/tap%d", i);
229 fd = open(devname, O_RDWR);
230 if (fd >= 0 || errno != EBUSY)
235 snprintf(name, IFNAMSIZ, "tap%d", i);
241 /* Main processing loop */
243 main_loop(__attribute__((unused)) void *arg)
245 const unsigned lcore_id = rte_lcore_id();
246 char tap_name[IFNAMSIZ];
249 if ((1ULL << lcore_id) & input_cores_mask) {
250 /* Create new tap interface */
251 snprintf(tap_name, IFNAMSIZ, "tap_dpdk_%.2u", lcore_id);
252 tap_fd = tap_create(tap_name);
254 FATAL_ERROR("Could not create tap interface \"%s\" (%d)",
257 PRINT_INFO("Lcore %u is reading from port %u and writing to %s",
258 lcore_id, (unsigned)port_ids[lcore_id], tap_name);
260 /* Loop forever reading from NIC and writing to tap */
262 struct rte_mbuf *pkts_burst[PKT_BURST_SZ];
264 const unsigned nb_rx =
265 rte_eth_rx_burst(port_ids[lcore_id], 0,
266 pkts_burst, PKT_BURST_SZ);
267 lcore_stats[lcore_id].rx += nb_rx;
268 for (i = 0; likely(i < nb_rx); i++) {
269 struct rte_mbuf *m = pkts_burst[i];
270 /* Ignore return val from write() */
271 int ret = write(tap_fd,
272 rte_pktmbuf_mtod(m, void*),
273 rte_pktmbuf_data_len(m));
275 if (unlikely(ret < 0))
276 lcore_stats[lcore_id].dropped++;
278 lcore_stats[lcore_id].tx++;
282 else if ((1ULL << lcore_id) & output_cores_mask) {
283 /* Create new tap interface */
284 snprintf(tap_name, IFNAMSIZ, "tap_dpdk_%.2u", lcore_id);
285 tap_fd = tap_create(tap_name);
287 FATAL_ERROR("Could not create tap interface \"%s\" (%d)",
290 PRINT_INFO("Lcore %u is reading from %s and writing to port %u",
291 lcore_id, tap_name, (unsigned)port_ids[lcore_id]);
293 /* Loop forever reading from tap and writing to NIC */
296 struct rte_mbuf *m = rte_pktmbuf_alloc(pktmbuf_pool);
300 ret = read(tap_fd, rte_pktmbuf_mtod(m, void *),
302 lcore_stats[lcore_id].rx++;
303 if (unlikely(ret < 0)) {
304 FATAL_ERROR("Reading from %s interface failed",
309 m->pkt_len = (uint16_t)ret;
310 m->data_len = (uint16_t)ret;
311 ret = rte_eth_tx_burst(port_ids[lcore_id], 0, &m, 1);
312 if (unlikely(ret < 1)) {
314 lcore_stats[lcore_id].dropped++;
317 lcore_stats[lcore_id].tx++;
322 PRINT_INFO("Lcore %u has nothing to do", lcore_id);
326 * Tap file is closed automatically when program exits. Putting close()
327 * here will cause the compiler to give an error about unreachable code.
331 /* Display usage instructions */
333 print_usage(const char *prgname)
335 PRINT_INFO("\nUsage: %s [EAL options] -- -p PORTMASK -i IN_CORES -o OUT_CORES\n"
336 " -p PORTMASK: hex bitmask of ports to use\n"
337 " -i IN_CORES: hex bitmask of cores which read from NIC\n"
338 " -o OUT_CORES: hex bitmask of cores which write to NIC",
342 /* Convert string to unsigned number. 0 is returned if error occurs */
344 parse_unsigned(const char *portmask)
349 num = strtoull(portmask, &end, 16);
350 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
353 return (uint64_t)num;
356 /* Record affinities between ports and lcores in global port_ids[] array */
358 setup_port_lcore_affinities(void)
361 uint16_t tx_port = 0;
362 uint16_t rx_port = 0;
364 /* Setup port_ids[] array, and check masks were ok */
365 RTE_LCORE_FOREACH(i) {
366 if (input_cores_mask & (1ULL << i)) {
367 /* Skip ports that are not enabled */
368 while ((ports_mask & (1 << rx_port)) == 0) {
370 if (rx_port > (sizeof(ports_mask) * 8))
371 goto fail; /* not enough ports */
374 port_ids[i] = rx_port++;
375 } else if (output_cores_mask & (1ULL << (i & 0x3f))) {
376 /* Skip ports that are not enabled */
377 while ((ports_mask & (1 << tx_port)) == 0) {
379 if (tx_port > (sizeof(ports_mask) * 8))
380 goto fail; /* not enough ports */
383 port_ids[i] = tx_port++;
387 if (rx_port != tx_port)
388 goto fail; /* uneven number of cores in masks */
390 if (ports_mask & (~((1 << rx_port) - 1)))
391 goto fail; /* unused ports */
395 FATAL_ERROR("Invalid core/port masks specified on command line");
398 /* Parse the arguments given in the command line of the application */
400 parse_args(int argc, char **argv)
403 const char *prgname = argv[0];
405 /* Disable printing messages within getopt() */
408 /* Parse command line */
409 while ((opt = getopt(argc, argv, "i:o:p:")) != EOF) {
412 input_cores_mask = parse_unsigned(optarg);
415 output_cores_mask = parse_unsigned(optarg);
418 ports_mask = parse_unsigned(optarg);
421 print_usage(prgname);
422 FATAL_ERROR("Invalid option specified");
426 /* Check that options were parsed ok */
427 if (input_cores_mask == 0) {
428 print_usage(prgname);
429 FATAL_ERROR("IN_CORES not specified correctly");
431 if (output_cores_mask == 0) {
432 print_usage(prgname);
433 FATAL_ERROR("OUT_CORES not specified correctly");
435 if (ports_mask == 0) {
436 print_usage(prgname);
437 FATAL_ERROR("PORTMASK not specified correctly");
440 setup_port_lcore_affinities();
443 /* Initialise a single port on an Ethernet device */
445 init_port(uint16_t port)
448 uint16_t nb_rxd = NB_RXD;
449 uint16_t nb_txd = NB_TXD;
451 /* Initialise device and RX/TX queues */
452 PRINT_INFO("Initialising port %u ...", port);
454 ret = rte_eth_dev_configure(port, 1, 1, &port_conf);
456 FATAL_ERROR("Could not configure port%u (%d)", port, ret);
458 ret = rte_eth_dev_adjust_nb_rx_tx_desc(port, &nb_rxd, &nb_txd);
460 FATAL_ERROR("Could not adjust number of descriptors for port%u (%d)",
463 ret = rte_eth_rx_queue_setup(port, 0, nb_rxd,
464 rte_eth_dev_socket_id(port),
468 FATAL_ERROR("Could not setup up RX queue for port%u (%d)",
471 ret = rte_eth_tx_queue_setup(port, 0, nb_txd,
472 rte_eth_dev_socket_id(port),
475 FATAL_ERROR("Could not setup up TX queue for port%u (%d)",
478 ret = rte_eth_dev_start(port);
480 FATAL_ERROR("Could not start port%u (%d)", port, ret);
482 rte_eth_promiscuous_enable(port);
485 /* Check the link status of all ports in up to 9s, and print them finally */
487 check_all_ports_link_status(uint16_t port_num, uint32_t port_mask)
489 #define CHECK_INTERVAL 100 /* 100ms */
490 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
492 uint8_t count, all_ports_up, print_flag = 0;
493 struct rte_eth_link link;
495 printf("\nChecking link status");
497 for (count = 0; count <= MAX_CHECK_TIME; count++) {
499 for (portid = 0; portid < port_num; portid++) {
500 if ((port_mask & (1 << portid)) == 0)
502 memset(&link, 0, sizeof(link));
503 rte_eth_link_get_nowait(portid, &link);
504 /* print link status if flag set */
505 if (print_flag == 1) {
506 if (link.link_status)
508 "Port%d Link Up. Speed %u Mbps - %s\n",
509 portid, link.link_speed,
510 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
511 ("full-duplex") : ("half-duplex\n"));
513 printf("Port %d Link Down\n", portid);
516 /* clear all_ports_up flag if any link down */
517 if (link.link_status == ETH_LINK_DOWN) {
522 /* after finally printing all link status, get out */
526 if (all_ports_up == 0) {
529 rte_delay_ms(CHECK_INTERVAL);
532 /* set the print_flag if all ports up or timeout */
533 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
540 /* Initialise ports/queues etc. and start main loop on each core */
542 main(int argc, char** argv)
545 unsigned i,high_port;
546 uint16_t nb_sys_ports, port;
548 /* Associate signal_hanlder function with USR signals */
549 signal(SIGUSR1, signal_handler);
550 signal(SIGUSR2, signal_handler);
553 ret = rte_eal_init(argc, argv);
555 FATAL_ERROR("Could not initialise EAL (%d)", ret);
559 /* Parse application arguments (after the EAL ones) */
560 parse_args(argc, argv);
562 /* Create the mbuf pool */
563 pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF,
564 MEMPOOL_CACHE_SZ, 0, MBUF_DATA_SZ, rte_socket_id());
565 if (pktmbuf_pool == NULL) {
566 FATAL_ERROR("Could not initialise mbuf pool");
570 /* Get number of ports found in scan */
571 nb_sys_ports = rte_eth_dev_count();
572 if (nb_sys_ports == 0)
573 FATAL_ERROR("No supported Ethernet device found");
574 /* Find highest port set in portmask */
575 for (high_port = (sizeof(ports_mask) * 8) - 1;
576 (high_port != 0) && !(ports_mask & (1 << high_port));
579 if (high_port > nb_sys_ports)
580 FATAL_ERROR("Port mask requires more ports than available");
582 /* Initialise each port */
583 for (port = 0; port < nb_sys_ports; port++) {
584 /* Skip ports that are not enabled */
585 if ((ports_mask & (1 << port)) == 0) {
590 check_all_ports_link_status(nb_sys_ports, ports_mask);
592 /* Launch per-lcore function on every lcore */
593 rte_eal_mp_remote_launch(main_loop, NULL, CALL_MASTER);
594 RTE_LCORE_FOREACH_SLAVE(i) {
595 if (rte_eal_wait_lcore(i) < 0)