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.
41 #include <rte_ethdev.h>
42 #include <rte_cycles.h>
43 #include <rte_malloc.h>
44 #include <rte_debug.h>
45 #include <rte_distributor.h>
47 #define RX_RING_SIZE 256
48 #define TX_RING_SIZE 512
49 #define NUM_MBUFS ((64*1024)-1)
50 #define MBUF_SIZE (2048 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
51 #define MBUF_CACHE_SIZE 250
53 #define RTE_RING_SZ 1024
55 /* uncommnet below line to enable debug logs */
59 #define LOG_LEVEL RTE_LOG_DEBUG
60 #define LOG_DEBUG(log_type, fmt, args...) do { \
61 RTE_LOG(DEBUG, log_type, fmt, ##args) \
64 #define LOG_LEVEL RTE_LOG_INFO
65 #define LOG_DEBUG(log_type, fmt, args...) do {} while (0)
68 #define RTE_LOGTYPE_DISTRAPP RTE_LOGTYPE_USER1
70 /* mask of enabled ports */
71 static uint32_t enabled_port_mask;
72 volatile uint8_t quit_signal;
73 volatile uint8_t quit_signal_rx;
75 static volatile struct app_stats {
78 uint64_t returned_pkts;
79 uint64_t enqueued_pkts;
80 } rx __rte_cache_aligned;
83 uint64_t dequeue_pkts;
85 } tx __rte_cache_aligned;
88 static const struct rte_eth_conf port_conf_default = {
90 .mq_mode = ETH_MQ_RX_RSS,
91 .max_rx_pkt_len = ETHER_MAX_LEN,
94 .mq_mode = ETH_MQ_TX_NONE,
98 .rss_hf = ETH_RSS_IPV4 | ETH_RSS_IPV6 |
99 ETH_RSS_IPV4_TCP | ETH_RSS_IPV4_UDP |
100 ETH_RSS_IPV6_TCP | ETH_RSS_IPV6_UDP,
105 struct output_buffer {
107 struct rte_mbuf *mbufs[BURST_SIZE];
111 * Initialises a given port using global settings and with the rx buffers
112 * coming from the mbuf_pool passed as parameter
115 port_init(uint8_t port, struct rte_mempool *mbuf_pool)
117 struct rte_eth_conf port_conf = port_conf_default;
118 const uint16_t rxRings = 1, txRings = rte_lcore_count() - 1;
122 if (port >= rte_eth_dev_count())
125 retval = rte_eth_dev_configure(port, rxRings, txRings, &port_conf);
129 for (q = 0; q < rxRings; q++) {
130 retval = rte_eth_rx_queue_setup(port, q, RX_RING_SIZE,
131 rte_eth_dev_socket_id(port),
137 for (q = 0; q < txRings; q++) {
138 retval = rte_eth_tx_queue_setup(port, q, TX_RING_SIZE,
139 rte_eth_dev_socket_id(port),
145 retval = rte_eth_dev_start(port);
149 struct rte_eth_link link;
150 rte_eth_link_get_nowait(port, &link);
151 if (!link.link_status) {
153 rte_eth_link_get_nowait(port, &link);
156 if (!link.link_status) {
157 printf("Link down on port %"PRIu8"\n", port);
161 struct ether_addr addr;
162 rte_eth_macaddr_get(port, &addr);
163 printf("Port %u MAC: %02"PRIx8" %02"PRIx8" %02"PRIx8
164 " %02"PRIx8" %02"PRIx8" %02"PRIx8"\n",
166 addr.addr_bytes[0], addr.addr_bytes[1],
167 addr.addr_bytes[2], addr.addr_bytes[3],
168 addr.addr_bytes[4], addr.addr_bytes[5]);
170 rte_eth_promiscuous_enable(port);
175 struct lcore_params {
177 struct rte_distributor *d;
179 struct rte_mempool *mem_pool;
183 quit_workers(struct rte_distributor *d, struct rte_mempool *p)
185 const unsigned num_workers = rte_lcore_count() - 2;
187 struct rte_mbuf *bufs[num_workers];
188 rte_mempool_get_bulk(p, (void *)bufs, num_workers);
190 for (i = 0; i < num_workers; i++)
191 bufs[i]->hash.rss = i << 1;
193 rte_distributor_process(d, bufs, num_workers);
194 rte_mempool_put_bulk(p, (void *)bufs, num_workers);
198 lcore_rx(struct lcore_params *p)
200 struct rte_distributor *d = p->d;
201 struct rte_mempool *mem_pool = p->mem_pool;
202 struct rte_ring *r = p->r;
203 const uint8_t nb_ports = rte_eth_dev_count();
204 const int socket_id = rte_socket_id();
207 for (port = 0; port < nb_ports; port++) {
208 /* skip ports that are not enabled */
209 if ((enabled_port_mask & (1 << port)) == 0)
212 if (rte_eth_dev_socket_id(port) > 0 &&
213 rte_eth_dev_socket_id(port) != socket_id)
214 printf("WARNING, port %u is on remote NUMA node to "
215 "RX thread.\n\tPerformance will not "
216 "be optimal.\n", port);
219 printf("\nCore %u doing packet RX.\n", rte_lcore_id());
221 while (!quit_signal_rx) {
223 /* skip ports that are not enabled */
224 if ((enabled_port_mask & (1 << port)) == 0) {
225 if (++port == nb_ports)
229 struct rte_mbuf *bufs[BURST_SIZE*2];
230 const uint16_t nb_rx = rte_eth_rx_burst(port, 0, bufs,
232 app_stats.rx.rx_pkts += nb_rx;
234 rte_distributor_process(d, bufs, nb_rx);
235 const uint16_t nb_ret = rte_distributor_returned_pkts(d,
237 app_stats.rx.returned_pkts += nb_ret;
238 if (unlikely(nb_ret == 0))
241 uint16_t sent = rte_ring_enqueue_burst(r, (void *)bufs, nb_ret);
242 app_stats.rx.enqueued_pkts += sent;
243 if (unlikely(sent < nb_ret)) {
244 LOG_DEBUG(DISTRAPP, "%s:Packet loss due to full ring\n", __func__);
245 while (sent < nb_ret)
246 rte_pktmbuf_free(bufs[sent++]);
248 if (++port == nb_ports)
251 rte_distributor_process(d, NULL, 0);
252 /* flush distributor to bring to known state */
253 rte_distributor_flush(d);
254 /* set worker & tx threads quit flag */
257 * worker threads may hang in get packet as
258 * distributor process is not running, just make sure workers
259 * get packets till quit_signal is actually been
260 * received and they gracefully shutdown
262 quit_workers(d, mem_pool);
263 /* rx thread should quit at last */
268 flush_one_port(struct output_buffer *outbuf, uint8_t outp)
270 unsigned nb_tx = rte_eth_tx_burst(outp, 0, outbuf->mbufs,
272 app_stats.tx.tx_pkts += nb_tx;
274 if (unlikely(nb_tx < outbuf->count)) {
275 LOG_DEBUG(DISTRAPP, "%s:Packet loss with tx_burst\n", __func__);
277 rte_pktmbuf_free(outbuf->mbufs[nb_tx]);
278 } while (++nb_tx < outbuf->count);
284 flush_all_ports(struct output_buffer *tx_buffers, uint8_t nb_ports)
287 for (outp = 0; outp < nb_ports; outp++) {
288 /* skip ports that are not enabled */
289 if ((enabled_port_mask & (1 << outp)) == 0)
292 if (tx_buffers[outp].count == 0)
295 flush_one_port(&tx_buffers[outp], outp);
300 lcore_tx(struct rte_ring *in_r)
302 static struct output_buffer tx_buffers[RTE_MAX_ETHPORTS];
303 const uint8_t nb_ports = rte_eth_dev_count();
304 const int socket_id = rte_socket_id();
307 for (port = 0; port < nb_ports; port++) {
308 /* skip ports that are not enabled */
309 if ((enabled_port_mask & (1 << port)) == 0)
312 if (rte_eth_dev_socket_id(port) > 0 &&
313 rte_eth_dev_socket_id(port) != socket_id)
314 printf("WARNING, port %u is on remote NUMA node to "
315 "TX thread.\n\tPerformance will not "
316 "be optimal.\n", port);
319 printf("\nCore %u doing packet TX.\n", rte_lcore_id());
320 while (!quit_signal) {
322 for (port = 0; port < nb_ports; port++) {
323 /* skip ports that are not enabled */
324 if ((enabled_port_mask & (1 << port)) == 0)
327 struct rte_mbuf *bufs[BURST_SIZE];
328 const uint16_t nb_rx = rte_ring_dequeue_burst(in_r,
329 (void *)bufs, BURST_SIZE);
330 app_stats.tx.dequeue_pkts += nb_rx;
332 /* if we get no traffic, flush anything we have */
333 if (unlikely(nb_rx == 0)) {
334 flush_all_ports(tx_buffers, nb_ports);
338 /* for traffic we receive, queue it up for transmit */
340 _mm_prefetch(bufs[0], 0);
341 _mm_prefetch(bufs[1], 0);
342 _mm_prefetch(bufs[2], 0);
343 for (i = 0; i < nb_rx; i++) {
344 struct output_buffer *outbuf;
346 _mm_prefetch(bufs[i + 3], 0);
348 * workers should update in_port to hold the
351 outp = bufs[i]->port;
352 /* skip ports that are not enabled */
353 if ((enabled_port_mask & (1 << outp)) == 0)
356 outbuf = &tx_buffers[outp];
357 outbuf->mbufs[outbuf->count++] = bufs[i];
358 if (outbuf->count == BURST_SIZE)
359 flush_one_port(outbuf, outp);
367 int_handler(int sig_num)
369 printf("Exiting on signal %d\n", sig_num);
370 /* set quit flag for rx thread to exit */
377 struct rte_eth_stats eth_stats;
380 printf("\nRX thread stats:\n");
381 printf(" - Received: %"PRIu64"\n", app_stats.rx.rx_pkts);
382 printf(" - Processed: %"PRIu64"\n", app_stats.rx.returned_pkts);
383 printf(" - Enqueued: %"PRIu64"\n", app_stats.rx.enqueued_pkts);
385 printf("\nTX thread stats:\n");
386 printf(" - Dequeued: %"PRIu64"\n", app_stats.tx.dequeue_pkts);
387 printf(" - Transmitted: %"PRIu64"\n", app_stats.tx.tx_pkts);
389 for (i = 0; i < rte_eth_dev_count(); i++) {
390 rte_eth_stats_get(i, ð_stats);
391 printf("\nPort %u stats:\n", i);
392 printf(" - Pkts in: %"PRIu64"\n", eth_stats.ipackets);
393 printf(" - Pkts out: %"PRIu64"\n", eth_stats.opackets);
394 printf(" - In Errs: %"PRIu64"\n", eth_stats.ierrors);
395 printf(" - Out Errs: %"PRIu64"\n", eth_stats.oerrors);
396 printf(" - Mbuf Errs: %"PRIu64"\n", eth_stats.rx_nombuf);
401 lcore_worker(struct lcore_params *p)
403 struct rte_distributor *d = p->d;
404 const unsigned id = p->worker_id;
406 * for single port, xor_val will be zero so we won't modify the output
407 * port, otherwise we send traffic from 0 to 1, 2 to 3, and vice versa
409 const unsigned xor_val = (rte_eth_dev_count() > 1);
410 struct rte_mbuf *buf = NULL;
412 printf("\nCore %u acting as worker core.\n", rte_lcore_id());
413 while (!quit_signal) {
414 buf = rte_distributor_get_pkt(d, id, buf);
415 buf->port ^= xor_val;
422 print_usage(const char *prgname)
424 printf("%s [EAL options] -- -p PORTMASK\n"
425 " -p PORTMASK: hexadecimal bitmask of ports to configure\n",
430 parse_portmask(const char *portmask)
435 /* parse hexadecimal string */
436 pm = strtoul(portmask, &end, 16);
437 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
446 /* Parse the argument given in the command line of the application */
448 parse_args(int argc, char **argv)
453 char *prgname = argv[0];
454 static struct option lgopts[] = {
460 while ((opt = getopt_long(argc, argvopt, "p:",
461 lgopts, &option_index)) != EOF) {
466 enabled_port_mask = parse_portmask(optarg);
467 if (enabled_port_mask == 0) {
468 printf("invalid portmask\n");
469 print_usage(prgname);
475 print_usage(prgname);
481 print_usage(prgname);
485 argv[optind-1] = prgname;
487 optind = 0; /* reset getopt lib */
491 /* Main function, does initialization and calls the per-lcore functions */
493 main(int argc, char *argv[])
495 struct rte_mempool *mbuf_pool;
496 struct rte_distributor *d;
497 struct rte_ring *output_ring;
498 unsigned lcore_id, worker_id = 0;
501 uint8_t nb_ports_available;
503 /* catch ctrl-c so we can print on exit */
504 signal(SIGINT, int_handler);
507 int ret = rte_eal_init(argc, argv);
509 rte_exit(EXIT_FAILURE, "Error with EAL initialization\n");
513 /* parse application arguments (after the EAL ones) */
514 ret = parse_args(argc, argv);
516 rte_exit(EXIT_FAILURE, "Invalid distributor parameters\n");
518 if (rte_lcore_count() < 3)
519 rte_exit(EXIT_FAILURE, "Error, This application needs at "
520 "least 3 logical cores to run:\n"
521 "1 lcore for packet RX and distribution\n"
522 "1 lcore for packet TX\n"
523 "and at least 1 lcore for worker threads\n");
525 nb_ports = rte_eth_dev_count();
527 rte_exit(EXIT_FAILURE, "Error: no ethernet ports detected\n");
528 if (nb_ports != 1 && (nb_ports & 1))
529 rte_exit(EXIT_FAILURE, "Error: number of ports must be even, except "
530 "when using a single port\n");
532 mbuf_pool = rte_mempool_create("MBUF_POOL", NUM_MBUFS * nb_ports,
533 MBUF_SIZE, MBUF_CACHE_SIZE,
534 sizeof(struct rte_pktmbuf_pool_private),
535 rte_pktmbuf_pool_init, NULL,
536 rte_pktmbuf_init, NULL,
538 if (mbuf_pool == NULL)
539 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
540 nb_ports_available = nb_ports;
542 /* initialize all ports */
543 for (portid = 0; portid < nb_ports; portid++) {
544 /* skip ports that are not enabled */
545 if ((enabled_port_mask & (1 << portid)) == 0) {
546 printf("\nSkipping disabled port %d\n", portid);
547 nb_ports_available--;
551 printf("Initializing port %u... done\n", (unsigned) portid);
553 if (port_init(portid, mbuf_pool) != 0)
554 rte_exit(EXIT_FAILURE, "Cannot initialize port %"PRIu8"\n",
558 if (!nb_ports_available) {
559 rte_exit(EXIT_FAILURE,
560 "All available ports are disabled. Please set portmask.\n");
563 d = rte_distributor_create("PKT_DIST", rte_socket_id(),
564 rte_lcore_count() - 2);
566 rte_exit(EXIT_FAILURE, "Cannot create distributor\n");
569 * scheduler ring is read only by the transmitter core, but written to
570 * by multiple threads
572 output_ring = rte_ring_create("Output_ring", RTE_RING_SZ,
573 rte_socket_id(), RING_F_SC_DEQ);
574 if (output_ring == NULL)
575 rte_exit(EXIT_FAILURE, "Cannot create output ring\n");
577 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
578 if (worker_id == rte_lcore_count() - 2)
579 rte_eal_remote_launch((lcore_function_t *)lcore_tx,
580 output_ring, lcore_id);
582 struct lcore_params *p =
583 rte_malloc(NULL, sizeof(*p), 0);
585 rte_panic("malloc failure\n");
586 *p = (struct lcore_params){worker_id, d, output_ring, mbuf_pool};
588 rte_eal_remote_launch((lcore_function_t *)lcore_worker,
593 /* call lcore_main on master core only */
594 struct lcore_params p = { 0, d, output_ring, mbuf_pool};
597 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
598 if (rte_eal_wait_lcore(lcore_id) < 0)