4 * Copyright(c) 2010-2012 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.
36 * Sample application demostrating how to do packet I/O in a multi-process
37 * environment. The same code can be run as a primary process and as a
38 * secondary process, just with a different proc-id parameter in each case
39 * (apart from the EAL flag to indicate a secondary process).
41 * Each process will read from the same ports, given by the port-mask
42 * parameter, which should be the same in each case, just using a different
43 * queue per port as determined by the proc-id parameter.
52 #include <sys/queue.h>
57 #include <rte_common.h>
59 #include <rte_memory.h>
60 #include <rte_memzone.h>
61 #include <rte_launch.h>
62 #include <rte_tailq.h>
64 #include <rte_per_lcore.h>
65 #include <rte_lcore.h>
66 #include <rte_debug.h>
67 #include <rte_atomic.h>
68 #include <rte_branch_prediction.h>
70 #include <rte_debug.h>
71 #include <rte_interrupts.h>
73 #include <rte_ether.h>
74 #include <rte_ethdev.h>
75 #include <rte_mempool.h>
76 #include <rte_memcpy.h>
78 #include <rte_string_fns.h>
80 #define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1
84 #define MBUF_SIZE (2048 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
85 #define NB_MBUFS 64*1024 /* use 64k mbufs */
86 #define MBUF_CACHE_SIZE 256
88 #define RX_RING_SIZE 128
89 #define TX_RING_SIZE 512
91 #define PARAM_PROC_ID "proc-id"
92 #define PARAM_NUM_PROCS "num-procs"
95 * RX and TX Prefetch, Host, and Write-back threshold values should be
96 * carefully set for optimal performance. Consult the network
97 * controller's datasheet and supporting DPDK documentation for guidance
98 * on how these parameters should be set.
100 /* Default configuration for rx and tx thresholds etc. */
101 static const struct rte_eth_rxconf rx_conf_default = {
110 * These default values are optimized for use with the Intel(R) 82599 10 GbE
111 * Controller and the DPDK ixgbe PMD. Consider using other values for other
112 * network controllers and/or network drivers.
114 static const struct rte_eth_txconf tx_conf_default = {
120 .tx_free_thresh = 0, /* Use PMD default values */
121 .tx_rs_thresh = 0, /* Use PMD default values */
124 /* for each lcore, record the elements of the ports array to use */
130 /* structure to record the rx and tx packets. Put two per cache line as ports
136 } __attribute__((aligned(CACHE_LINE_SIZE / 2)));
138 static int proc_id = -1;
139 static unsigned num_procs = 0;
141 static uint8_t ports[RTE_MAX_ETHPORTS];
142 static unsigned num_ports = 0;
144 static struct lcore_ports lcore_ports[RTE_MAX_LCORE];
145 static struct port_stats pstats[RTE_MAX_ETHPORTS];
147 /* prints the usage statement and quits with an error message */
149 smp_usage(const char *prgname, const char *errmsg)
151 printf("\nError: %s\n",errmsg);
152 printf("\n%s [EAL options] -- -p <port mask> "
153 "--"PARAM_NUM_PROCS" <n>"
154 " --"PARAM_PROC_ID" <id>\n"
155 "-p : a hex bitmask indicating what ports are to be used\n"
156 "--num-procs: the number of processes which will be used\n"
157 "--proc-id : the id of the current process (id < num-procs)\n"
164 /* signal handler configured for SIGTERM and SIGINT to print stats on exit */
166 print_stats(int signum)
169 printf("\nExiting on signal %d\n\n", signum);
170 for (i = 0; i < num_ports; i++){
171 const uint8_t p_num = ports[i];
172 printf("Port %u: RX - %u, TX - %u, Drop - %u\n", (unsigned)p_num,
173 pstats[p_num].rx, pstats[p_num].tx, pstats[p_num].drop);
178 /* Parse the argument given in the command line of the application */
180 smp_parse_args(int argc, char **argv)
185 unsigned i, port_mask = 0;
186 char *prgname = argv[0];
187 static struct option lgopts[] = {
188 {PARAM_NUM_PROCS, 1, 0, 0},
189 {PARAM_PROC_ID, 1, 0, 0},
195 while ((opt = getopt_long(argc, argvopt, "p:", \
196 lgopts, &option_index)) != EOF) {
200 port_mask = strtoull(optarg, NULL, 16);
204 if (strncmp(lgopts[option_index].name, PARAM_NUM_PROCS, 8) == 0)
205 num_procs = atoi(optarg);
206 else if (strncmp(lgopts[option_index].name, PARAM_PROC_ID, 7) == 0)
207 proc_id = atoi(optarg);
211 smp_usage(prgname, "Cannot parse all command-line arguments\n");
216 argv[optind-1] = prgname;
219 smp_usage(prgname, "Invalid or missing proc-id parameter\n");
220 if (rte_eal_process_type() == RTE_PROC_PRIMARY && num_procs == 0)
221 smp_usage(prgname, "Invalid or missing num-procs parameter\n");
223 smp_usage(prgname, "Invalid or missing port mask\n");
225 /* get the port numbers from the port mask */
226 for(i = 0; i < rte_eth_dev_count(); i++)
227 if(port_mask & (1 << i))
228 ports[num_ports++] = (uint8_t)i;
231 optind = 0; /* reset getopt lib */
236 /* Queries the link status of a port and prints it to screen */
238 report_link_status(uint8_t port)
240 /* get link status */
241 struct rte_eth_link link;
242 rte_eth_link_get(port, &link);
243 if (link.link_status)
244 printf("Port %u: Link Up - %u Gbps - %s\n", (unsigned)port,
245 (unsigned) link.link_speed / 1000,
246 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
247 ("full-duplex") : ("half-duplex\n"));
249 printf("Port %u: Link Down\n", (unsigned)port);
253 * Initialises a given port using global settings and with the rx buffers
254 * coming from the mbuf_pool passed as parameter
257 smp_port_init(uint8_t port, struct rte_mempool *mbuf_pool, uint16_t num_queues)
259 struct rte_eth_conf port_conf = {
263 .header_split = 0, /**< Header Split disabled */
264 .hw_ip_checksum = 1, /**< IP checksum offload enabled */
265 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
266 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
267 .hw_strip_crc = 0, /**< CRC stripped by hardware */
272 .rss_hf = ETH_RSS_IPV4,
278 const uint16_t rx_rings = num_queues, tx_rings = num_queues;
282 if (rte_eal_process_type() == RTE_PROC_SECONDARY)
285 if (port >= rte_eth_dev_count())
288 printf("# Initialising port %u... ", (unsigned)port);
291 retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf);
295 for (q = 0; q < rx_rings; q ++) {
296 retval = rte_eth_rx_queue_setup(port, q, RX_RING_SIZE,
297 SOCKET0, &rx_conf_default,
303 for (q = 0; q < tx_rings; q ++) {
304 retval = rte_eth_tx_queue_setup(port, q, RX_RING_SIZE,
305 SOCKET0, &tx_conf_default);
310 rte_eth_promiscuous_enable(port);
312 retval = rte_eth_dev_start(port);
319 /* Goes through each of the lcores and calculates what ports should
320 * be used by that core. Fills in the global lcore_ports[] array.
323 assign_ports_to_cores(void)
326 const unsigned lcores = rte_eal_get_configuration()->lcore_count;
327 const unsigned port_pairs = num_ports / 2;
328 const unsigned pairs_per_lcore = port_pairs / lcores;
329 unsigned extra_pairs = port_pairs % lcores;
330 unsigned ports_assigned = 0;
333 RTE_LCORE_FOREACH(i) {
334 lcore_ports[i].start_port = ports_assigned;
335 lcore_ports[i].num_ports = pairs_per_lcore * 2;
336 if (extra_pairs > 0) {
337 lcore_ports[i].num_ports += 2;
340 ports_assigned += lcore_ports[i].num_ports;
344 /* Main function used by the processing threads.
345 * Prints out some configuration details for the thread and then begins
346 * performing packet RX and TX.
349 lcore_main(void *arg __rte_unused)
351 const unsigned id = rte_lcore_id();
352 const unsigned start_port = lcore_ports[id].start_port;
353 const unsigned end_port = start_port + lcore_ports[id].num_ports;
354 const uint16_t q_id = (uint16_t)proc_id;
359 if (start_port == end_port){
360 printf("Lcore %u has nothing to do\n", id);
364 /* build up message in msgbuf before printing to decrease likelihood
365 * of multi-core message interleaving.
367 msgbufpos += rte_snprintf(msgbuf, sizeof(msgbuf) - msgbufpos,
368 "Lcore %u using ports ", id);
369 for (p = start_port; p < end_port; p++){
370 msgbufpos += rte_snprintf(msgbuf + msgbufpos, sizeof(msgbuf) - msgbufpos,
371 "%u ", (unsigned)ports[p]);
373 printf("%s\n", msgbuf);
374 printf("lcore %u using queue %u of each port\n", id, (unsigned)q_id);
376 /* handle packet I/O from the ports, reading and writing to the
377 * queue number corresponding to our process number (not lcore id)
381 struct rte_mbuf *buf[PKT_BURST];
383 for (p = start_port; p < end_port; p++) {
384 const uint8_t src = ports[p];
385 const uint8_t dst = ports[p ^ 1]; /* 0 <-> 1, 2 <-> 3 etc */
386 const uint16_t rx_c = rte_eth_rx_burst(src, q_id, buf, PKT_BURST);
389 pstats[src].rx += rx_c;
391 const uint16_t tx_c = rte_eth_tx_burst(dst, q_id, buf, rx_c);
392 pstats[dst].tx += tx_c;
394 pstats[dst].drop += (rx_c - tx_c);
395 for (i = tx_c; i < rx_c; i++)
396 rte_pktmbuf_free(buf[i]);
403 * Performs initialisation and then calls the lcore_main on each core
404 * to do the packet-processing work.
407 main(int argc, char **argv)
409 static const char *_SMP_MBUF_POOL = "SMP_MBUF_POOL";
412 enum rte_proc_type_t proc_type;
413 struct rte_mempool *mp;
415 /* set up signal handlers to print stats on exit */
416 signal(SIGINT, print_stats);
417 signal(SIGTERM, print_stats);
419 /* initialise the EAL for all */
420 ret = rte_eal_init(argc, argv);
422 rte_exit(EXIT_FAILURE, "Cannot init EAL\n");
426 /* probe to determine the NIC devices available */
427 proc_type = rte_eal_process_type();
428 #ifdef RTE_LIBRTE_IGB_PMD
429 if (rte_igb_pmd_init() < 0)
430 rte_exit(EXIT_FAILURE, "Cannot init igb pmd\n");
432 #ifdef RTE_LIBRTE_IXGBE_PMD
433 if (rte_ixgbe_pmd_init() < 0)
434 rte_exit(EXIT_FAILURE, "Cannot init ixgbe pmd\n");
436 if (rte_eal_pci_probe() < 0)
437 rte_exit(EXIT_FAILURE, "Cannot probe PCI\n");
438 if (rte_eth_dev_count() == 0)
439 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
441 /* parse application arguments (those after the EAL ones) */
442 smp_parse_args(argc, argv);
444 mp = (proc_type == RTE_PROC_SECONDARY) ?
445 rte_mempool_lookup(_SMP_MBUF_POOL) :
446 rte_mempool_create(_SMP_MBUF_POOL, NB_MBUFS, MBUF_SIZE,
447 MBUF_CACHE_SIZE, sizeof(struct rte_pktmbuf_pool_private),
448 rte_pktmbuf_pool_init, NULL,
449 rte_pktmbuf_init, NULL,
452 rte_exit(EXIT_FAILURE, "Cannot get memory pool for buffers\n");
455 rte_exit(EXIT_FAILURE, "Application must use an even number of ports\n");
456 for(i = 0; i < num_ports; i++){
457 if(proc_type == RTE_PROC_PRIMARY)
458 if (smp_port_init(ports[i], mp, (uint16_t)num_procs) < 0)
459 rte_exit(EXIT_FAILURE, "Error initialising ports\n");
460 report_link_status(ports[i]);
463 assign_ports_to_cores();
465 RTE_LOG(INFO, APP, "Finished Process Init.\n");
467 rte_eal_mp_remote_launch(lcore_main, NULL, CALL_MASTER);