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.
35 * Sample application demostrating how to do packet I/O in a multi-process
36 * environment. The same code can be run as a primary process and as a
37 * secondary process, just with a different proc-id parameter in each case
38 * (apart from the EAL flag to indicate a secondary process).
40 * Each process will read from the same ports, given by the port-mask
41 * parameter, which should be the same in each case, just using a different
42 * queue per port as determined by the proc-id parameter.
51 #include <sys/queue.h>
56 #include <rte_common.h>
58 #include <rte_memory.h>
59 #include <rte_memzone.h>
60 #include <rte_launch.h>
61 #include <rte_tailq.h>
63 #include <rte_per_lcore.h>
64 #include <rte_lcore.h>
65 #include <rte_debug.h>
66 #include <rte_atomic.h>
67 #include <rte_branch_prediction.h>
69 #include <rte_debug.h>
70 #include <rte_interrupts.h>
72 #include <rte_ether.h>
73 #include <rte_ethdev.h>
74 #include <rte_mempool.h>
75 #include <rte_memcpy.h>
77 #include <rte_string_fns.h>
78 #include <rte_cycles.h>
80 #define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1
82 #define MBUF_SIZE (2048 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
83 #define NB_MBUFS 64*1024 /* use 64k mbufs */
84 #define MBUF_CACHE_SIZE 256
86 #define RX_RING_SIZE 128
87 #define TX_RING_SIZE 512
89 #define PARAM_PROC_ID "proc-id"
90 #define PARAM_NUM_PROCS "num-procs"
93 * RX and TX Prefetch, Host, and Write-back threshold values should be
94 * carefully set for optimal performance. Consult the network
95 * controller's datasheet and supporting DPDK documentation for guidance
96 * on how these parameters should be set.
98 /* Default configuration for rx and tx thresholds etc. */
99 static const struct rte_eth_rxconf rx_conf_default = {
108 * These default values are optimized for use with the Intel(R) 82599 10 GbE
109 * Controller and the DPDK ixgbe PMD. Consider using other values for other
110 * network controllers and/or network drivers.
112 static const struct rte_eth_txconf tx_conf_default = {
118 .tx_free_thresh = 0, /* Use PMD default values */
119 .tx_rs_thresh = 0, /* Use PMD default values */
122 /* for each lcore, record the elements of the ports array to use */
128 /* structure to record the rx and tx packets. Put two per cache line as ports
134 } __attribute__((aligned(CACHE_LINE_SIZE / 2)));
136 static int proc_id = -1;
137 static unsigned num_procs = 0;
139 static uint8_t ports[RTE_MAX_ETHPORTS];
140 static unsigned num_ports = 0;
142 static struct lcore_ports lcore_ports[RTE_MAX_LCORE];
143 static struct port_stats pstats[RTE_MAX_ETHPORTS];
145 /* prints the usage statement and quits with an error message */
147 smp_usage(const char *prgname, const char *errmsg)
149 printf("\nError: %s\n",errmsg);
150 printf("\n%s [EAL options] -- -p <port mask> "
151 "--"PARAM_NUM_PROCS" <n>"
152 " --"PARAM_PROC_ID" <id>\n"
153 "-p : a hex bitmask indicating what ports are to be used\n"
154 "--num-procs: the number of processes which will be used\n"
155 "--proc-id : the id of the current process (id < num-procs)\n"
162 /* signal handler configured for SIGTERM and SIGINT to print stats on exit */
164 print_stats(int signum)
167 printf("\nExiting on signal %d\n\n", signum);
168 for (i = 0; i < num_ports; i++){
169 const uint8_t p_num = ports[i];
170 printf("Port %u: RX - %u, TX - %u, Drop - %u\n", (unsigned)p_num,
171 pstats[p_num].rx, pstats[p_num].tx, pstats[p_num].drop);
176 /* Parse the argument given in the command line of the application */
178 smp_parse_args(int argc, char **argv)
183 unsigned i, port_mask = 0;
184 char *prgname = argv[0];
185 static struct option lgopts[] = {
186 {PARAM_NUM_PROCS, 1, 0, 0},
187 {PARAM_PROC_ID, 1, 0, 0},
193 while ((opt = getopt_long(argc, argvopt, "p:", \
194 lgopts, &option_index)) != EOF) {
198 port_mask = strtoull(optarg, NULL, 16);
202 if (strncmp(lgopts[option_index].name, PARAM_NUM_PROCS, 8) == 0)
203 num_procs = atoi(optarg);
204 else if (strncmp(lgopts[option_index].name, PARAM_PROC_ID, 7) == 0)
205 proc_id = atoi(optarg);
209 smp_usage(prgname, "Cannot parse all command-line arguments\n");
214 argv[optind-1] = prgname;
217 smp_usage(prgname, "Invalid or missing proc-id parameter\n");
218 if (rte_eal_process_type() == RTE_PROC_PRIMARY && num_procs == 0)
219 smp_usage(prgname, "Invalid or missing num-procs parameter\n");
221 smp_usage(prgname, "Invalid or missing port mask\n");
223 /* get the port numbers from the port mask */
224 for(i = 0; i < rte_eth_dev_count(); i++)
225 if(port_mask & (1 << i))
226 ports[num_ports++] = (uint8_t)i;
229 optind = 0; /* reset getopt lib */
235 * Initialises a given port using global settings and with the rx buffers
236 * coming from the mbuf_pool passed as parameter
239 smp_port_init(uint8_t port, struct rte_mempool *mbuf_pool, uint16_t num_queues)
241 struct rte_eth_conf port_conf = {
243 .mq_mode = ETH_MQ_RX_RSS,
245 .header_split = 0, /**< Header Split disabled */
246 .hw_ip_checksum = 1, /**< IP checksum offload enabled */
247 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
248 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
249 .hw_strip_crc = 0, /**< CRC stripped by hardware */
254 .rss_hf = ETH_RSS_IPV4 | ETH_RSS_IPV6,
258 .mq_mode = ETH_MQ_TX_NONE,
261 const uint16_t rx_rings = num_queues, tx_rings = num_queues;
265 if (rte_eal_process_type() == RTE_PROC_SECONDARY)
268 if (port >= rte_eth_dev_count())
271 printf("# Initialising port %u... ", (unsigned)port);
274 retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf);
278 for (q = 0; q < rx_rings; q ++) {
279 retval = rte_eth_rx_queue_setup(port, q, RX_RING_SIZE,
280 rte_eth_dev_socket_id(port), &rx_conf_default,
286 for (q = 0; q < tx_rings; q ++) {
287 retval = rte_eth_tx_queue_setup(port, q, TX_RING_SIZE,
288 rte_eth_dev_socket_id(port), &tx_conf_default);
293 rte_eth_promiscuous_enable(port);
295 retval = rte_eth_dev_start(port);
302 /* Goes through each of the lcores and calculates what ports should
303 * be used by that core. Fills in the global lcore_ports[] array.
306 assign_ports_to_cores(void)
309 const unsigned lcores = rte_eal_get_configuration()->lcore_count;
310 const unsigned port_pairs = num_ports / 2;
311 const unsigned pairs_per_lcore = port_pairs / lcores;
312 unsigned extra_pairs = port_pairs % lcores;
313 unsigned ports_assigned = 0;
316 RTE_LCORE_FOREACH(i) {
317 lcore_ports[i].start_port = ports_assigned;
318 lcore_ports[i].num_ports = pairs_per_lcore * 2;
319 if (extra_pairs > 0) {
320 lcore_ports[i].num_ports += 2;
323 ports_assigned += lcore_ports[i].num_ports;
327 /* Main function used by the processing threads.
328 * Prints out some configuration details for the thread and then begins
329 * performing packet RX and TX.
332 lcore_main(void *arg __rte_unused)
334 const unsigned id = rte_lcore_id();
335 const unsigned start_port = lcore_ports[id].start_port;
336 const unsigned end_port = start_port + lcore_ports[id].num_ports;
337 const uint16_t q_id = (uint16_t)proc_id;
342 if (start_port == end_port){
343 printf("Lcore %u has nothing to do\n", id);
347 /* build up message in msgbuf before printing to decrease likelihood
348 * of multi-core message interleaving.
350 msgbufpos += rte_snprintf(msgbuf, sizeof(msgbuf) - msgbufpos,
351 "Lcore %u using ports ", id);
352 for (p = start_port; p < end_port; p++){
353 msgbufpos += rte_snprintf(msgbuf + msgbufpos, sizeof(msgbuf) - msgbufpos,
354 "%u ", (unsigned)ports[p]);
356 printf("%s\n", msgbuf);
357 printf("lcore %u using queue %u of each port\n", id, (unsigned)q_id);
359 /* handle packet I/O from the ports, reading and writing to the
360 * queue number corresponding to our process number (not lcore id)
364 struct rte_mbuf *buf[PKT_BURST];
366 for (p = start_port; p < end_port; p++) {
367 const uint8_t src = ports[p];
368 const uint8_t dst = ports[p ^ 1]; /* 0 <-> 1, 2 <-> 3 etc */
369 const uint16_t rx_c = rte_eth_rx_burst(src, q_id, buf, PKT_BURST);
372 pstats[src].rx += rx_c;
374 const uint16_t tx_c = rte_eth_tx_burst(dst, q_id, buf, rx_c);
375 pstats[dst].tx += tx_c;
377 pstats[dst].drop += (rx_c - tx_c);
378 for (i = tx_c; i < rx_c; i++)
379 rte_pktmbuf_free(buf[i]);
385 /* Check the link status of all ports in up to 9s, and print them finally */
387 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
389 #define CHECK_INTERVAL 100 /* 100ms */
390 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
391 uint8_t portid, count, all_ports_up, print_flag = 0;
392 struct rte_eth_link link;
394 printf("\nChecking link status");
396 for (count = 0; count <= MAX_CHECK_TIME; count++) {
398 for (portid = 0; portid < port_num; portid++) {
399 if ((port_mask & (1 << portid)) == 0)
401 memset(&link, 0, sizeof(link));
402 rte_eth_link_get_nowait(portid, &link);
403 /* print link status if flag set */
404 if (print_flag == 1) {
405 if (link.link_status)
406 printf("Port %d Link Up - speed %u "
407 "Mbps - %s\n", (uint8_t)portid,
408 (unsigned)link.link_speed,
409 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
410 ("full-duplex") : ("half-duplex\n"));
412 printf("Port %d Link Down\n",
416 /* clear all_ports_up flag if any link down */
417 if (link.link_status == 0) {
422 /* after finally printing all link status, get out */
426 if (all_ports_up == 0) {
429 rte_delay_ms(CHECK_INTERVAL);
432 /* set the print_flag if all ports up or timeout */
433 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
441 * Performs initialisation and then calls the lcore_main on each core
442 * to do the packet-processing work.
445 main(int argc, char **argv)
447 static const char *_SMP_MBUF_POOL = "SMP_MBUF_POOL";
450 enum rte_proc_type_t proc_type;
451 struct rte_mempool *mp;
453 /* set up signal handlers to print stats on exit */
454 signal(SIGINT, print_stats);
455 signal(SIGTERM, print_stats);
457 /* initialise the EAL for all */
458 ret = rte_eal_init(argc, argv);
460 rte_exit(EXIT_FAILURE, "Cannot init EAL\n");
464 /* probe to determine the NIC devices available */
465 proc_type = rte_eal_process_type();
466 if (rte_eal_pci_probe() < 0)
467 rte_exit(EXIT_FAILURE, "Cannot probe PCI\n");
468 if (rte_eth_dev_count() == 0)
469 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
471 /* parse application arguments (those after the EAL ones) */
472 smp_parse_args(argc, argv);
474 mp = (proc_type == RTE_PROC_SECONDARY) ?
475 rte_mempool_lookup(_SMP_MBUF_POOL) :
476 rte_mempool_create(_SMP_MBUF_POOL, NB_MBUFS, MBUF_SIZE,
477 MBUF_CACHE_SIZE, sizeof(struct rte_pktmbuf_pool_private),
478 rte_pktmbuf_pool_init, NULL,
479 rte_pktmbuf_init, NULL,
482 rte_exit(EXIT_FAILURE, "Cannot get memory pool for buffers\n");
485 rte_exit(EXIT_FAILURE, "Application must use an even number of ports\n");
486 for(i = 0; i < num_ports; i++){
487 if(proc_type == RTE_PROC_PRIMARY)
488 if (smp_port_init(ports[i], mp, (uint16_t)num_procs) < 0)
489 rte_exit(EXIT_FAILURE, "Error initialising ports\n");
492 if (proc_type == RTE_PROC_PRIMARY)
493 check_all_ports_link_status((uint8_t)num_ports, (~0x0));
495 assign_ports_to_cores();
497 RTE_LOG(INFO, APP, "Finished Process Init.\n");
499 rte_eal_mp_remote_launch(lcore_main, NULL, CALL_MASTER);