1 /*- 2 * BSD LICENSE 3 * 4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 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 16 * distribution. 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. 20 * 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. 32 */ 33 34 /* 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). 39 * 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. 43 */ 44 45 #include <stdio.h> 46 #include <string.h> 47 #include <stdint.h> 48 #include <stdlib.h> 49 #include <stdarg.h> 50 #include <errno.h> 51 #include <sys/queue.h> 52 #include <getopt.h> 53 #include <signal.h> 54 #include <inttypes.h> 55 56 #include <rte_common.h> 57 #include <rte_log.h> 58 #include <rte_memory.h> 59 #include <rte_memzone.h> 60 #include <rte_launch.h> 61 #include <rte_eal.h> 62 #include <rte_per_lcore.h> 63 #include <rte_lcore.h> 64 #include <rte_debug.h> 65 #include <rte_atomic.h> 66 #include <rte_branch_prediction.h> 67 #include <rte_ring.h> 68 #include <rte_debug.h> 69 #include <rte_interrupts.h> 70 #include <rte_pci.h> 71 #include <rte_ether.h> 72 #include <rte_ethdev.h> 73 #include <rte_mempool.h> 74 #include <rte_memcpy.h> 75 #include <rte_mbuf.h> 76 #include <rte_string_fns.h> 77 #include <rte_cycles.h> 78 79 #define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1 80 81 #define NB_MBUFS 64*1024 /* use 64k mbufs */ 82 #define MBUF_CACHE_SIZE 256 83 #define PKT_BURST 32 84 #define RX_RING_SIZE 128 85 #define TX_RING_SIZE 512 86 87 #define PARAM_PROC_ID "proc-id" 88 #define PARAM_NUM_PROCS "num-procs" 89 90 /* for each lcore, record the elements of the ports array to use */ 91 struct lcore_ports{ 92 unsigned start_port; 93 unsigned num_ports; 94 }; 95 96 /* structure to record the rx and tx packets. Put two per cache line as ports 97 * used in pairs */ 98 struct port_stats{ 99 unsigned rx; 100 unsigned tx; 101 unsigned drop; 102 } __attribute__((aligned(RTE_CACHE_LINE_SIZE / 2))); 103 104 static int proc_id = -1; 105 static unsigned num_procs = 0; 106 107 static uint8_t ports[RTE_MAX_ETHPORTS]; 108 static unsigned num_ports = 0; 109 110 static struct lcore_ports lcore_ports[RTE_MAX_LCORE]; 111 static struct port_stats pstats[RTE_MAX_ETHPORTS]; 112 113 /* prints the usage statement and quits with an error message */ 114 static void 115 smp_usage(const char *prgname, const char *errmsg) 116 { 117 printf("\nError: %s\n",errmsg); 118 printf("\n%s [EAL options] -- -p <port mask> " 119 "--"PARAM_NUM_PROCS" <n>" 120 " --"PARAM_PROC_ID" <id>\n" 121 "-p : a hex bitmask indicating what ports are to be used\n" 122 "--num-procs: the number of processes which will be used\n" 123 "--proc-id : the id of the current process (id < num-procs)\n" 124 "\n", 125 prgname); 126 exit(1); 127 } 128 129 130 /* signal handler configured for SIGTERM and SIGINT to print stats on exit */ 131 static void 132 print_stats(int signum) 133 { 134 unsigned i; 135 printf("\nExiting on signal %d\n\n", signum); 136 for (i = 0; i < num_ports; i++){ 137 const uint8_t p_num = ports[i]; 138 printf("Port %u: RX - %u, TX - %u, Drop - %u\n", (unsigned)p_num, 139 pstats[p_num].rx, pstats[p_num].tx, pstats[p_num].drop); 140 } 141 exit(0); 142 } 143 144 /* Parse the argument given in the command line of the application */ 145 static int 146 smp_parse_args(int argc, char **argv) 147 { 148 int opt, ret; 149 char **argvopt; 150 int option_index; 151 unsigned i, port_mask = 0; 152 char *prgname = argv[0]; 153 static struct option lgopts[] = { 154 {PARAM_NUM_PROCS, 1, 0, 0}, 155 {PARAM_PROC_ID, 1, 0, 0}, 156 {NULL, 0, 0, 0} 157 }; 158 159 argvopt = argv; 160 161 while ((opt = getopt_long(argc, argvopt, "p:", \ 162 lgopts, &option_index)) != EOF) { 163 164 switch (opt) { 165 case 'p': 166 port_mask = strtoull(optarg, NULL, 16); 167 break; 168 /* long options */ 169 case 0: 170 if (strncmp(lgopts[option_index].name, PARAM_NUM_PROCS, 8) == 0) 171 num_procs = atoi(optarg); 172 else if (strncmp(lgopts[option_index].name, PARAM_PROC_ID, 7) == 0) 173 proc_id = atoi(optarg); 174 break; 175 176 default: 177 smp_usage(prgname, "Cannot parse all command-line arguments\n"); 178 } 179 } 180 181 if (optind >= 0) 182 argv[optind-1] = prgname; 183 184 if (proc_id < 0) 185 smp_usage(prgname, "Invalid or missing proc-id parameter\n"); 186 if (rte_eal_process_type() == RTE_PROC_PRIMARY && num_procs == 0) 187 smp_usage(prgname, "Invalid or missing num-procs parameter\n"); 188 if (port_mask == 0) 189 smp_usage(prgname, "Invalid or missing port mask\n"); 190 191 /* get the port numbers from the port mask */ 192 for(i = 0; i < rte_eth_dev_count(); i++) 193 if(port_mask & (1 << i)) 194 ports[num_ports++] = (uint8_t)i; 195 196 ret = optind-1; 197 optind = 0; /* reset getopt lib */ 198 199 return ret; 200 } 201 202 /* 203 * Initialises a given port using global settings and with the rx buffers 204 * coming from the mbuf_pool passed as parameter 205 */ 206 static inline int 207 smp_port_init(uint8_t port, struct rte_mempool *mbuf_pool, uint16_t num_queues) 208 { 209 struct rte_eth_conf port_conf = { 210 .rxmode = { 211 .mq_mode = ETH_MQ_RX_RSS, 212 .split_hdr_size = 0, 213 .header_split = 0, /**< Header Split disabled */ 214 .hw_ip_checksum = 1, /**< IP checksum offload enabled */ 215 .hw_vlan_filter = 0, /**< VLAN filtering disabled */ 216 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */ 217 .hw_strip_crc = 0, /**< CRC stripped by hardware */ 218 }, 219 .rx_adv_conf = { 220 .rss_conf = { 221 .rss_key = NULL, 222 .rss_hf = ETH_RSS_IP, 223 }, 224 }, 225 .txmode = { 226 .mq_mode = ETH_MQ_TX_NONE, 227 } 228 }; 229 const uint16_t rx_rings = num_queues, tx_rings = num_queues; 230 struct rte_eth_dev_info info; 231 int retval; 232 uint16_t q; 233 234 if (rte_eal_process_type() == RTE_PROC_SECONDARY) 235 return 0; 236 237 if (port >= rte_eth_dev_count()) 238 return -1; 239 240 printf("# Initialising port %u... ", (unsigned)port); 241 fflush(stdout); 242 243 rte_eth_dev_info_get(port, &info); 244 info.default_rxconf.rx_drop_en = 1; 245 246 retval = rte_eth_dev_configure(port, rx_rings, tx_rings, &port_conf); 247 if (retval < 0) 248 return retval; 249 250 for (q = 0; q < rx_rings; q ++) { 251 retval = rte_eth_rx_queue_setup(port, q, RX_RING_SIZE, 252 rte_eth_dev_socket_id(port), 253 &info.default_rxconf, 254 mbuf_pool); 255 if (retval < 0) 256 return retval; 257 } 258 259 for (q = 0; q < tx_rings; q ++) { 260 retval = rte_eth_tx_queue_setup(port, q, TX_RING_SIZE, 261 rte_eth_dev_socket_id(port), 262 NULL); 263 if (retval < 0) 264 return retval; 265 } 266 267 rte_eth_promiscuous_enable(port); 268 269 retval = rte_eth_dev_start(port); 270 if (retval < 0) 271 return retval; 272 273 return 0; 274 } 275 276 /* Goes through each of the lcores and calculates what ports should 277 * be used by that core. Fills in the global lcore_ports[] array. 278 */ 279 static void 280 assign_ports_to_cores(void) 281 { 282 283 const unsigned lcores = rte_eal_get_configuration()->lcore_count; 284 const unsigned port_pairs = num_ports / 2; 285 const unsigned pairs_per_lcore = port_pairs / lcores; 286 unsigned extra_pairs = port_pairs % lcores; 287 unsigned ports_assigned = 0; 288 unsigned i; 289 290 RTE_LCORE_FOREACH(i) { 291 lcore_ports[i].start_port = ports_assigned; 292 lcore_ports[i].num_ports = pairs_per_lcore * 2; 293 if (extra_pairs > 0) { 294 lcore_ports[i].num_ports += 2; 295 extra_pairs--; 296 } 297 ports_assigned += lcore_ports[i].num_ports; 298 } 299 } 300 301 /* Main function used by the processing threads. 302 * Prints out some configuration details for the thread and then begins 303 * performing packet RX and TX. 304 */ 305 static int 306 lcore_main(void *arg __rte_unused) 307 { 308 const unsigned id = rte_lcore_id(); 309 const unsigned start_port = lcore_ports[id].start_port; 310 const unsigned end_port = start_port + lcore_ports[id].num_ports; 311 const uint16_t q_id = (uint16_t)proc_id; 312 unsigned p, i; 313 char msgbuf[256]; 314 int msgbufpos = 0; 315 316 if (start_port == end_port){ 317 printf("Lcore %u has nothing to do\n", id); 318 return 0; 319 } 320 321 /* build up message in msgbuf before printing to decrease likelihood 322 * of multi-core message interleaving. 323 */ 324 msgbufpos += snprintf(msgbuf, sizeof(msgbuf) - msgbufpos, 325 "Lcore %u using ports ", id); 326 for (p = start_port; p < end_port; p++){ 327 msgbufpos += snprintf(msgbuf + msgbufpos, sizeof(msgbuf) - msgbufpos, 328 "%u ", (unsigned)ports[p]); 329 } 330 printf("%s\n", msgbuf); 331 printf("lcore %u using queue %u of each port\n", id, (unsigned)q_id); 332 333 /* handle packet I/O from the ports, reading and writing to the 334 * queue number corresponding to our process number (not lcore id) 335 */ 336 337 for (;;) { 338 struct rte_mbuf *buf[PKT_BURST]; 339 340 for (p = start_port; p < end_port; p++) { 341 const uint8_t src = ports[p]; 342 const uint8_t dst = ports[p ^ 1]; /* 0 <-> 1, 2 <-> 3 etc */ 343 const uint16_t rx_c = rte_eth_rx_burst(src, q_id, buf, PKT_BURST); 344 if (rx_c == 0) 345 continue; 346 pstats[src].rx += rx_c; 347 348 const uint16_t tx_c = rte_eth_tx_burst(dst, q_id, buf, rx_c); 349 pstats[dst].tx += tx_c; 350 if (tx_c != rx_c) { 351 pstats[dst].drop += (rx_c - tx_c); 352 for (i = tx_c; i < rx_c; i++) 353 rte_pktmbuf_free(buf[i]); 354 } 355 } 356 } 357 } 358 359 /* Check the link status of all ports in up to 9s, and print them finally */ 360 static void 361 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask) 362 { 363 #define CHECK_INTERVAL 100 /* 100ms */ 364 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */ 365 uint8_t portid, count, all_ports_up, print_flag = 0; 366 struct rte_eth_link link; 367 368 printf("\nChecking link status"); 369 fflush(stdout); 370 for (count = 0; count <= MAX_CHECK_TIME; count++) { 371 all_ports_up = 1; 372 for (portid = 0; portid < port_num; portid++) { 373 if ((port_mask & (1 << portid)) == 0) 374 continue; 375 memset(&link, 0, sizeof(link)); 376 rte_eth_link_get_nowait(portid, &link); 377 /* print link status if flag set */ 378 if (print_flag == 1) { 379 if (link.link_status) 380 printf("Port %d Link Up - speed %u " 381 "Mbps - %s\n", (uint8_t)portid, 382 (unsigned)link.link_speed, 383 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ? 384 ("full-duplex") : ("half-duplex\n")); 385 else 386 printf("Port %d Link Down\n", 387 (uint8_t)portid); 388 continue; 389 } 390 /* clear all_ports_up flag if any link down */ 391 if (link.link_status == ETH_LINK_DOWN) { 392 all_ports_up = 0; 393 break; 394 } 395 } 396 /* after finally printing all link status, get out */ 397 if (print_flag == 1) 398 break; 399 400 if (all_ports_up == 0) { 401 printf("."); 402 fflush(stdout); 403 rte_delay_ms(CHECK_INTERVAL); 404 } 405 406 /* set the print_flag if all ports up or timeout */ 407 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) { 408 print_flag = 1; 409 printf("done\n"); 410 } 411 } 412 } 413 414 /* Main function. 415 * Performs initialisation and then calls the lcore_main on each core 416 * to do the packet-processing work. 417 */ 418 int 419 main(int argc, char **argv) 420 { 421 static const char *_SMP_MBUF_POOL = "SMP_MBUF_POOL"; 422 int ret; 423 unsigned i; 424 enum rte_proc_type_t proc_type; 425 struct rte_mempool *mp; 426 427 /* set up signal handlers to print stats on exit */ 428 signal(SIGINT, print_stats); 429 signal(SIGTERM, print_stats); 430 431 /* initialise the EAL for all */ 432 ret = rte_eal_init(argc, argv); 433 if (ret < 0) 434 rte_exit(EXIT_FAILURE, "Cannot init EAL\n"); 435 argc -= ret; 436 argv += ret; 437 438 /* determine the NIC devices available */ 439 if (rte_eth_dev_count() == 0) 440 rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n"); 441 442 /* parse application arguments (those after the EAL ones) */ 443 smp_parse_args(argc, argv); 444 445 proc_type = rte_eal_process_type(); 446 mp = (proc_type == RTE_PROC_SECONDARY) ? 447 rte_mempool_lookup(_SMP_MBUF_POOL) : 448 rte_pktmbuf_pool_create(_SMP_MBUF_POOL, NB_MBUFS, 449 MBUF_CACHE_SIZE, 0, RTE_MBUF_DEFAULT_BUF_SIZE, 450 rte_socket_id()); 451 if (mp == NULL) 452 rte_exit(EXIT_FAILURE, "Cannot get memory pool for buffers\n"); 453 454 if (num_ports & 1) 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 } 461 462 if (proc_type == RTE_PROC_PRIMARY) 463 check_all_ports_link_status((uint8_t)num_ports, (~0x0)); 464 465 assign_ports_to_cores(); 466 467 RTE_LOG(INFO, APP, "Finished Process Init.\n"); 468 469 rte_eal_mp_remote_launch(lcore_main, NULL, CALL_MASTER); 470 471 return 0; 472 } 473