4 * Copyright(c) 2015-2016 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.
40 #include <sys/types.h>
41 #include <sys/queue.h>
42 #include <netinet/in.h>
49 #include <rte_atomic.h>
50 #include <rte_branch_prediction.h>
51 #include <rte_common.h>
52 #include <rte_cryptodev.h>
53 #include <rte_cycles.h>
54 #include <rte_debug.h>
56 #include <rte_ether.h>
57 #include <rte_ethdev.h>
58 #include <rte_interrupts.h>
60 #include <rte_launch.h>
61 #include <rte_lcore.h>
63 #include <rte_malloc.h>
65 #include <rte_mbuf_offload.h>
66 #include <rte_memcpy.h>
67 #include <rte_memory.h>
68 #include <rte_mempool.h>
69 #include <rte_memzone.h>
71 #include <rte_per_lcore.h>
72 #include <rte_prefetch.h>
73 #include <rte_random.h>
76 #define RTE_LOGTYPE_L2FWD RTE_LOGTYPE_USER1
80 #define MAX_PKT_BURST 32
81 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
84 * Configurable number of RX/TX ring descriptors
86 #define RTE_TEST_RX_DESC_DEFAULT 128
87 #define RTE_TEST_TX_DESC_DEFAULT 512
88 static uint16_t nb_rxd = RTE_TEST_RX_DESC_DEFAULT;
89 static uint16_t nb_txd = RTE_TEST_TX_DESC_DEFAULT;
91 /* ethernet addresses of ports */
92 static struct ether_addr l2fwd_ports_eth_addr[RTE_MAX_ETHPORTS];
94 /* mask of enabled ports */
95 static uint64_t l2fwd_enabled_port_mask;
96 static uint64_t l2fwd_enabled_crypto_mask;
98 /* list of enabled ports */
99 static uint32_t l2fwd_dst_ports[RTE_MAX_ETHPORTS];
104 struct rte_mbuf *buffer[MAX_PKT_BURST];
107 #define MAX_RX_QUEUE_PER_LCORE 16
108 #define MAX_TX_QUEUE_PER_PORT 16
110 enum l2fwd_crypto_xform_chain {
111 L2FWD_CRYPTO_CIPHER_HASH,
112 L2FWD_CRYPTO_HASH_CIPHER
115 /** l2fwd crypto application command line options */
116 struct l2fwd_crypto_options {
118 unsigned nb_ports_per_lcore;
119 unsigned refresh_period;
120 unsigned single_lcore:1;
122 enum rte_cryptodev_type cdev_type;
123 unsigned sessionless:1;
125 enum l2fwd_crypto_xform_chain xform_chain;
127 struct rte_crypto_sym_xform cipher_xform;
128 uint8_t ckey_data[32];
130 struct rte_crypto_key iv_key;
131 uint8_t ivkey_data[16];
133 struct rte_crypto_sym_xform auth_xform;
134 uint8_t akey_data[128];
137 /** l2fwd crypto lcore params */
138 struct l2fwd_crypto_params {
142 unsigned digest_length;
144 struct rte_crypto_key iv_key;
145 struct rte_cryptodev_sym_session *session;
148 /** lcore configuration */
149 struct lcore_queue_conf {
150 unsigned nb_rx_ports;
151 unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
153 unsigned nb_crypto_devs;
154 unsigned cryptodev_list[MAX_RX_QUEUE_PER_LCORE];
156 struct pkt_buffer crypto_pkt_buf[RTE_MAX_ETHPORTS];
157 struct pkt_buffer tx_pkt_buf[RTE_MAX_ETHPORTS];
158 } __rte_cache_aligned;
160 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
162 static const struct rte_eth_conf port_conf = {
165 .header_split = 0, /**< Header Split disabled */
166 .hw_ip_checksum = 0, /**< IP checksum offload disabled */
167 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
168 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
169 .hw_strip_crc = 0, /**< CRC stripped by hardware */
172 .mq_mode = ETH_MQ_TX_NONE,
176 struct rte_mempool *l2fwd_pktmbuf_pool;
177 struct rte_mempool *l2fwd_mbuf_ol_pool;
179 /* Per-port statistics struct */
180 struct l2fwd_port_statistics {
184 uint64_t crypto_enqueued;
185 uint64_t crypto_dequeued;
188 } __rte_cache_aligned;
190 struct l2fwd_crypto_statistics {
195 } __rte_cache_aligned;
197 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
198 struct l2fwd_crypto_statistics crypto_statistics[RTE_MAX_ETHPORTS];
200 /* A tsc-based timer responsible for triggering statistics printout */
201 #define TIMER_MILLISECOND 2000000ULL /* around 1ms at 2 Ghz */
202 #define MAX_TIMER_PERIOD 86400 /* 1 day max */
204 /* default period is 10 seconds */
205 static int64_t timer_period = 10 * TIMER_MILLISECOND * 1000;
207 /* Print out statistics on packets dropped */
211 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
212 uint64_t total_packets_enqueued, total_packets_dequeued,
213 total_packets_errors;
217 total_packets_dropped = 0;
218 total_packets_tx = 0;
219 total_packets_rx = 0;
220 total_packets_enqueued = 0;
221 total_packets_dequeued = 0;
222 total_packets_errors = 0;
224 const char clr[] = { 27, '[', '2', 'J', '\0' };
225 const char topLeft[] = { 27, '[', '1', ';', '1', 'H', '\0' };
227 /* Clear screen and move to top left */
228 printf("%s%s", clr, topLeft);
230 printf("\nPort statistics ====================================");
232 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
233 /* skip disabled ports */
234 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
236 printf("\nStatistics for port %u ------------------------------"
237 "\nPackets sent: %32"PRIu64
238 "\nPackets received: %28"PRIu64
239 "\nPackets dropped: %29"PRIu64,
241 port_statistics[portid].tx,
242 port_statistics[portid].rx,
243 port_statistics[portid].dropped);
245 total_packets_dropped += port_statistics[portid].dropped;
246 total_packets_tx += port_statistics[portid].tx;
247 total_packets_rx += port_statistics[portid].rx;
249 printf("\nCrypto statistics ==================================");
251 for (cdevid = 0; cdevid < RTE_CRYPTO_MAX_DEVS; cdevid++) {
252 /* skip disabled ports */
253 if ((l2fwd_enabled_crypto_mask & (1lu << cdevid)) == 0)
255 printf("\nStatistics for cryptodev %"PRIu64
256 " -------------------------"
257 "\nPackets enqueued: %28"PRIu64
258 "\nPackets dequeued: %28"PRIu64
259 "\nPackets errors: %30"PRIu64,
261 crypto_statistics[cdevid].enqueued,
262 crypto_statistics[cdevid].dequeued,
263 crypto_statistics[cdevid].errors);
265 total_packets_enqueued += crypto_statistics[cdevid].enqueued;
266 total_packets_dequeued += crypto_statistics[cdevid].dequeued;
267 total_packets_errors += crypto_statistics[cdevid].errors;
269 printf("\nAggregate statistics ==============================="
270 "\nTotal packets received: %22"PRIu64
271 "\nTotal packets enqueued: %22"PRIu64
272 "\nTotal packets dequeued: %22"PRIu64
273 "\nTotal packets sent: %26"PRIu64
274 "\nTotal packets dropped: %23"PRIu64
275 "\nTotal packets crypto errors: %17"PRIu64,
277 total_packets_enqueued,
278 total_packets_dequeued,
280 total_packets_dropped,
281 total_packets_errors);
282 printf("\n====================================================\n");
288 l2fwd_crypto_send_burst(struct lcore_queue_conf *qconf, unsigned n,
289 struct l2fwd_crypto_params *cparams)
291 struct rte_mbuf **pkt_buffer;
294 pkt_buffer = (struct rte_mbuf **)
295 qconf->crypto_pkt_buf[cparams->dev_id].buffer;
297 ret = rte_cryptodev_enqueue_burst(cparams->dev_id, cparams->qp_id,
298 pkt_buffer, (uint16_t) n);
299 crypto_statistics[cparams->dev_id].enqueued += ret;
300 if (unlikely(ret < n)) {
301 crypto_statistics[cparams->dev_id].errors += (n - ret);
303 rte_pktmbuf_offload_free(pkt_buffer[ret]->offload_ops);
304 rte_pktmbuf_free(pkt_buffer[ret]);
312 l2fwd_crypto_enqueue(struct rte_mbuf *m, struct l2fwd_crypto_params *cparams)
314 unsigned lcore_id, len;
315 struct lcore_queue_conf *qconf;
317 lcore_id = rte_lcore_id();
319 qconf = &lcore_queue_conf[lcore_id];
320 len = qconf->crypto_pkt_buf[cparams->dev_id].len;
321 qconf->crypto_pkt_buf[cparams->dev_id].buffer[len] = m;
324 /* enough pkts to be sent */
325 if (len == MAX_PKT_BURST) {
326 l2fwd_crypto_send_burst(qconf, MAX_PKT_BURST, cparams);
330 qconf->crypto_pkt_buf[cparams->dev_id].len = len;
335 l2fwd_simple_crypto_enqueue(struct rte_mbuf *m,
336 struct rte_mbuf_offload *ol,
337 struct l2fwd_crypto_params *cparams)
339 struct ether_hdr *eth_hdr;
340 struct ipv4_hdr *ip_hdr;
342 unsigned ipdata_offset, pad_len, data_len;
345 eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
347 if (eth_hdr->ether_type != rte_cpu_to_be_16(ETHER_TYPE_IPv4))
350 ipdata_offset = sizeof(struct ether_hdr);
352 ip_hdr = (struct ipv4_hdr *)(rte_pktmbuf_mtod(m, char *) +
355 ipdata_offset += (ip_hdr->version_ihl & IPV4_HDR_IHL_MASK)
356 * IPV4_IHL_MULTIPLIER;
359 /* Zero pad data to be crypto'd so it is block aligned */
360 data_len = rte_pktmbuf_data_len(m) - ipdata_offset;
361 pad_len = data_len % cparams->block_size ? cparams->block_size -
362 (data_len % cparams->block_size) : 0;
365 padding = rte_pktmbuf_append(m, pad_len);
366 if (unlikely(!padding))
370 memset(padding, 0, pad_len);
373 /* Set crypto operation data parameters */
374 rte_crypto_sym_op_attach_session(&ol->op.crypto, cparams->session);
376 /* Append space for digest to end of packet */
377 ol->op.crypto.digest.data = (uint8_t *)rte_pktmbuf_append(m,
378 cparams->digest_length);
379 ol->op.crypto.digest.phys_addr = rte_pktmbuf_mtophys_offset(m,
380 rte_pktmbuf_pkt_len(m) - cparams->digest_length);
381 ol->op.crypto.digest.length = cparams->digest_length;
383 ol->op.crypto.iv.data = cparams->iv_key.data;
384 ol->op.crypto.iv.phys_addr = cparams->iv_key.phys_addr;
385 ol->op.crypto.iv.length = cparams->iv_key.length;
387 ol->op.crypto.data.to_cipher.offset = ipdata_offset;
388 ol->op.crypto.data.to_cipher.length = data_len;
390 ol->op.crypto.data.to_hash.offset = ipdata_offset;
391 ol->op.crypto.data.to_hash.length = data_len;
393 rte_pktmbuf_offload_attach(m, ol);
395 return l2fwd_crypto_enqueue(m, cparams);
399 /* Send the burst of packets on an output interface */
401 l2fwd_send_burst(struct lcore_queue_conf *qconf, unsigned n, uint8_t port)
403 struct rte_mbuf **pkt_buffer;
405 unsigned queueid = 0;
407 pkt_buffer = (struct rte_mbuf **)qconf->tx_pkt_buf[port].buffer;
409 ret = rte_eth_tx_burst(port, (uint16_t) queueid, pkt_buffer,
411 port_statistics[port].tx += ret;
412 if (unlikely(ret < n)) {
413 port_statistics[port].dropped += (n - ret);
415 rte_pktmbuf_free(pkt_buffer[ret]);
422 /* Enqueue packets for TX and prepare them to be sent */
424 l2fwd_send_packet(struct rte_mbuf *m, uint8_t port)
426 unsigned lcore_id, len;
427 struct lcore_queue_conf *qconf;
429 lcore_id = rte_lcore_id();
431 qconf = &lcore_queue_conf[lcore_id];
432 len = qconf->tx_pkt_buf[port].len;
433 qconf->tx_pkt_buf[port].buffer[len] = m;
436 /* enough pkts to be sent */
437 if (unlikely(len == MAX_PKT_BURST)) {
438 l2fwd_send_burst(qconf, MAX_PKT_BURST, port);
442 qconf->tx_pkt_buf[port].len = len;
447 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
449 struct ether_hdr *eth;
453 dst_port = l2fwd_dst_ports[portid];
454 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
456 /* 02:00:00:00:00:xx */
457 tmp = ð->d_addr.addr_bytes[0];
458 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dst_port << 40);
461 ether_addr_copy(&l2fwd_ports_eth_addr[dst_port], ð->s_addr);
463 l2fwd_send_packet(m, (uint8_t) dst_port);
466 /** Generate random key */
468 generate_random_key(uint8_t *key, unsigned length)
472 for (i = 0; i < length; i++)
473 key[i] = rand() % 0xff;
476 static struct rte_cryptodev_sym_session *
477 initialize_crypto_session(struct l2fwd_crypto_options *options,
480 struct rte_crypto_sym_xform *first_xform;
482 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH) {
483 first_xform = &options->cipher_xform;
484 first_xform->next = &options->auth_xform;
486 first_xform = &options->auth_xform;
487 first_xform->next = &options->cipher_xform;
490 /* Setup Cipher Parameters */
491 return rte_cryptodev_sym_session_create(cdev_id, first_xform);
495 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options);
497 /* main processing loop */
499 l2fwd_main_loop(struct l2fwd_crypto_options *options)
501 struct rte_mbuf *m, *pkts_burst[MAX_PKT_BURST];
502 unsigned lcore_id = rte_lcore_id();
503 uint64_t prev_tsc = 0, diff_tsc, cur_tsc, timer_tsc = 0;
504 unsigned i, j, portid, nb_rx;
505 struct lcore_queue_conf *qconf = &lcore_queue_conf[lcore_id];
506 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) /
507 US_PER_S * BURST_TX_DRAIN_US;
508 struct l2fwd_crypto_params *cparams;
509 struct l2fwd_crypto_params port_cparams[qconf->nb_crypto_devs];
511 if (qconf->nb_rx_ports == 0) {
512 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
516 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
518 l2fwd_crypto_options_print(options);
520 for (i = 0; i < qconf->nb_rx_ports; i++) {
522 portid = qconf->rx_port_list[i];
523 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
527 for (i = 0; i < qconf->nb_crypto_devs; i++) {
528 port_cparams[i].dev_id = qconf->cryptodev_list[i];
529 port_cparams[i].qp_id = 0;
531 port_cparams[i].block_size = 64;
532 port_cparams[i].digest_length = 20;
534 port_cparams[i].iv_key.data =
535 (uint8_t *)rte_malloc(NULL, 16, 8);
536 port_cparams[i].iv_key.length = 16;
537 port_cparams[i].iv_key.phys_addr = rte_malloc_virt2phy(
538 (void *)port_cparams[i].iv_key.data);
539 generate_random_key(port_cparams[i].iv_key.data,
540 sizeof(cparams[i].iv_key.length));
542 port_cparams[i].session = initialize_crypto_session(options,
543 port_cparams[i].dev_id);
545 if (port_cparams[i].session == NULL)
547 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u cryptoid=%u\n", lcore_id,
548 port_cparams[i].dev_id);
553 cur_tsc = rte_rdtsc();
556 * TX burst queue drain
558 diff_tsc = cur_tsc - prev_tsc;
559 if (unlikely(diff_tsc > drain_tsc)) {
561 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
562 if (qconf->tx_pkt_buf[portid].len == 0)
564 l2fwd_send_burst(&lcore_queue_conf[lcore_id],
565 qconf->tx_pkt_buf[portid].len,
567 qconf->tx_pkt_buf[portid].len = 0;
570 /* if timer is enabled */
571 if (timer_period > 0) {
573 /* advance the timer */
574 timer_tsc += diff_tsc;
576 /* if timer has reached its timeout */
577 if (unlikely(timer_tsc >=
578 (uint64_t)timer_period)) {
580 /* do this only on master core */
581 if (lcore_id == rte_get_master_lcore()
582 && options->refresh_period) {
593 * Read packet from RX queues
595 for (i = 0; i < qconf->nb_rx_ports; i++) {
596 struct rte_mbuf_offload *ol;
598 portid = qconf->rx_port_list[i];
600 cparams = &port_cparams[i];
602 nb_rx = rte_eth_rx_burst((uint8_t) portid, 0,
603 pkts_burst, MAX_PKT_BURST);
605 port_statistics[portid].rx += nb_rx;
607 /* Enqueue packets from Crypto device*/
608 for (j = 0; j < nb_rx; j++) {
610 ol = rte_pktmbuf_offload_alloc(
612 RTE_PKTMBUF_OL_CRYPTO_SYM);
614 * If we can't allocate a offload, then drop
615 * the rest of the burst and dequeue and
616 * process the packets to free offload structs
618 if (unlikely(ol == NULL)) {
619 for (; j < nb_rx; j++) {
620 rte_pktmbuf_free(pkts_burst[j]);
621 port_statistics[portid].dropped++;
626 rte_prefetch0(rte_pktmbuf_mtod(m, void *));
627 rte_prefetch0((void *)ol);
629 l2fwd_simple_crypto_enqueue(m, ol, cparams);
632 /* Dequeue packets from Crypto device */
633 nb_rx = rte_cryptodev_dequeue_burst(
634 cparams->dev_id, cparams->qp_id,
635 pkts_burst, MAX_PKT_BURST);
636 crypto_statistics[cparams->dev_id].dequeued += nb_rx;
638 /* Forward crypto'd packets */
639 for (j = 0; j < nb_rx; j++) {
641 rte_pktmbuf_offload_free(m->offload_ops);
642 rte_prefetch0(rte_pktmbuf_mtod(m, void *));
643 l2fwd_simple_forward(m, portid);
650 l2fwd_launch_one_lcore(void *arg)
652 l2fwd_main_loop((struct l2fwd_crypto_options *)arg);
656 /* Display command line arguments usage */
658 l2fwd_crypto_usage(const char *prgname)
660 printf("%s [EAL options] -- --cdev TYPE [optional parameters]\n"
661 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
662 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
663 " -s manage all ports from single lcore"
664 " -t PERIOD: statistics will be refreshed each PERIOD seconds"
665 " (0 to disable, 10 default, 86400 maximum)\n"
667 " --cdev AESNI_MB / QAT\n"
668 " --chain HASH_CIPHER / CIPHER_HASH\n"
670 " --cipher_algo ALGO\n"
671 " --cipher_op ENCRYPT / DECRYPT\n"
672 " --cipher_key KEY\n"
675 " --auth_algo ALGO\n"
676 " --auth_op GENERATE / VERIFY\n"
683 /** Parse crypto device type command line argument */
685 parse_cryptodev_type(enum rte_cryptodev_type *type, char *optarg)
687 if (strcmp("AESNI_MB", optarg) == 0) {
688 *type = RTE_CRYPTODEV_AESNI_MB_PMD;
690 } else if (strcmp("QAT", optarg) == 0) {
691 *type = RTE_CRYPTODEV_QAT_SYM_PMD;
698 /** Parse crypto chain xform command line argument */
700 parse_crypto_opt_chain(struct l2fwd_crypto_options *options, char *optarg)
702 if (strcmp("CIPHER_HASH", optarg) == 0) {
703 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
705 } else if (strcmp("HASH_CIPHER", optarg) == 0) {
706 options->xform_chain = L2FWD_CRYPTO_HASH_CIPHER;
713 /** Parse crypto cipher algo option command line argument */
715 parse_cipher_algo(enum rte_crypto_cipher_algorithm *algo, char *optarg)
717 if (strcmp("AES_CBC", optarg) == 0) {
718 *algo = RTE_CRYPTO_CIPHER_AES_CBC;
720 } else if (strcmp("AES_GCM", optarg) == 0) {
721 *algo = RTE_CRYPTO_CIPHER_AES_GCM;
725 printf("Cipher algorithm not supported!\n");
729 /** Parse crypto cipher operation command line argument */
731 parse_cipher_op(enum rte_crypto_cipher_operation *op, char *optarg)
733 if (strcmp("ENCRYPT", optarg) == 0) {
734 *op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
736 } else if (strcmp("DECRYPT", optarg) == 0) {
737 *op = RTE_CRYPTO_CIPHER_OP_DECRYPT;
741 printf("Cipher operation not supported!\n");
745 /** Parse crypto key command line argument */
747 parse_key(struct rte_crypto_key *key __rte_unused,
748 unsigned length __rte_unused, char *arg __rte_unused)
750 printf("Currently an unsupported argument!\n");
754 /** Parse crypto cipher operation command line argument */
756 parse_auth_algo(enum rte_crypto_auth_algorithm *algo, char *optarg)
758 if (strcmp("SHA1", optarg) == 0) {
759 *algo = RTE_CRYPTO_AUTH_SHA1;
761 } else if (strcmp("SHA1_HMAC", optarg) == 0) {
762 *algo = RTE_CRYPTO_AUTH_SHA1_HMAC;
764 } else if (strcmp("SHA224", optarg) == 0) {
765 *algo = RTE_CRYPTO_AUTH_SHA224;
767 } else if (strcmp("SHA224_HMAC", optarg) == 0) {
768 *algo = RTE_CRYPTO_AUTH_SHA224_HMAC;
770 } else if (strcmp("SHA256", optarg) == 0) {
771 *algo = RTE_CRYPTO_AUTH_SHA256;
773 } else if (strcmp("SHA256_HMAC", optarg) == 0) {
774 *algo = RTE_CRYPTO_AUTH_SHA256_HMAC;
776 } else if (strcmp("SHA512", optarg) == 0) {
777 *algo = RTE_CRYPTO_AUTH_SHA256;
779 } else if (strcmp("SHA512_HMAC", optarg) == 0) {
780 *algo = RTE_CRYPTO_AUTH_SHA256_HMAC;
784 printf("Authentication algorithm specified not supported!\n");
789 parse_auth_op(enum rte_crypto_auth_operation *op, char *optarg)
791 if (strcmp("VERIFY", optarg) == 0) {
792 *op = RTE_CRYPTO_AUTH_OP_VERIFY;
794 } else if (strcmp("GENERATE", optarg) == 0) {
795 *op = RTE_CRYPTO_AUTH_OP_GENERATE;
799 printf("Authentication operation specified not supported!\n");
803 /** Parse long options */
805 l2fwd_crypto_parse_args_long_options(struct l2fwd_crypto_options *options,
806 struct option *lgopts, int option_index)
808 if (strcmp(lgopts[option_index].name, "cdev_type") == 0)
809 return parse_cryptodev_type(&options->cdev_type, optarg);
811 else if (strcmp(lgopts[option_index].name, "chain") == 0)
812 return parse_crypto_opt_chain(options, optarg);
815 else if (strcmp(lgopts[option_index].name, "cipher_algo") == 0)
816 return parse_cipher_algo(&options->cipher_xform.cipher.algo,
819 else if (strcmp(lgopts[option_index].name, "cipher_op") == 0)
820 return parse_cipher_op(&options->cipher_xform.cipher.op,
823 else if (strcmp(lgopts[option_index].name, "cipher_key") == 0)
824 return parse_key(&options->cipher_xform.cipher.key,
825 sizeof(options->ckey_data), optarg);
827 else if (strcmp(lgopts[option_index].name, "iv") == 0)
828 return parse_key(&options->iv_key, sizeof(options->ivkey_data),
831 /* Authentication options */
832 else if (strcmp(lgopts[option_index].name, "auth_algo") == 0)
833 return parse_auth_algo(&options->auth_xform.auth.algo,
836 else if (strcmp(lgopts[option_index].name, "auth_op") == 0)
837 return parse_auth_op(&options->auth_xform.auth.op,
840 else if (strcmp(lgopts[option_index].name, "auth_key") == 0)
841 return parse_key(&options->auth_xform.auth.key,
842 sizeof(options->akey_data), optarg);
844 else if (strcmp(lgopts[option_index].name, "sessionless") == 0) {
845 options->sessionless = 1;
852 /** Parse port mask */
854 l2fwd_crypto_parse_portmask(struct l2fwd_crypto_options *options,
860 /* parse hexadecimal string */
861 pm = strtoul(q_arg, &end, 16);
862 if ((pm == '\0') || (end == NULL) || (*end != '\0'))
865 options->portmask = pm;
866 if (options->portmask == 0) {
867 printf("invalid portmask specified\n");
874 /** Parse number of queues */
876 l2fwd_crypto_parse_nqueue(struct l2fwd_crypto_options *options,
882 /* parse hexadecimal string */
883 n = strtoul(q_arg, &end, 10);
884 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
886 else if (n >= MAX_RX_QUEUE_PER_LCORE)
889 options->nb_ports_per_lcore = n;
890 if (options->nb_ports_per_lcore == 0) {
891 printf("invalid number of ports selected\n");
898 /** Parse timer period */
900 l2fwd_crypto_parse_timer_period(struct l2fwd_crypto_options *options,
906 /* parse number string */
907 n = strtol(q_arg, &end, 10);
908 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
911 if (n >= MAX_TIMER_PERIOD) {
912 printf("Warning refresh period specified %ld is greater than "
913 "max value %d! using max value",
914 n, MAX_TIMER_PERIOD);
915 n = MAX_TIMER_PERIOD;
918 options->refresh_period = n * 1000 * TIMER_MILLISECOND;
923 /** Generate default options for application */
925 l2fwd_crypto_default_options(struct l2fwd_crypto_options *options)
929 options->portmask = 0xffffffff;
930 options->nb_ports_per_lcore = 1;
931 options->refresh_period = 10000;
932 options->single_lcore = 0;
934 options->cdev_type = RTE_CRYPTODEV_AESNI_MB_PMD;
935 options->sessionless = 0;
936 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
939 options->cipher_xform.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
940 options->cipher_xform.next = NULL;
942 options->cipher_xform.cipher.algo = RTE_CRYPTO_CIPHER_AES_CBC;
943 options->cipher_xform.cipher.op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
945 generate_random_key(options->ckey_data, sizeof(options->ckey_data));
947 options->cipher_xform.cipher.key.data = options->ckey_data;
948 options->cipher_xform.cipher.key.length = 16;
951 /* Authentication Data */
952 options->auth_xform.type = RTE_CRYPTO_SYM_XFORM_AUTH;
953 options->auth_xform.next = NULL;
955 options->auth_xform.auth.algo = RTE_CRYPTO_AUTH_SHA1_HMAC;
956 options->auth_xform.auth.op = RTE_CRYPTO_AUTH_OP_VERIFY;
958 options->auth_xform.auth.add_auth_data_length = 0;
959 options->auth_xform.auth.digest_length = 20;
961 generate_random_key(options->akey_data, sizeof(options->akey_data));
963 options->auth_xform.auth.key.data = options->akey_data;
964 options->auth_xform.auth.key.length = 20;
968 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options)
970 printf("Options:-\nn");
971 printf("portmask: %x\n", options->portmask);
972 printf("ports per lcore: %u\n", options->nb_ports_per_lcore);
973 printf("refresh period : %u\n", options->refresh_period);
974 printf("single lcore mode: %s\n",
975 options->single_lcore ? "enabled" : "disabled");
976 printf("stats_printing: %s\n",
977 options->refresh_period == 0 ? "disabled" : "enabled");
979 switch (options->cdev_type) {
980 case RTE_CRYPTODEV_AESNI_MB_PMD:
981 printf("cryptodev type: AES-NI MB PMD\n"); break;
982 case RTE_CRYPTODEV_QAT_SYM_PMD:
983 printf("cryptodev type: QAT PMD\n"); break;
988 printf("sessionless crypto: %s\n",
989 options->sessionless ? "enabled" : "disabled");
991 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
994 options->cipher_xform.type = RTE_CRYPTO_XFORM_CIPHER;
995 options->cipher_xform.next = NULL;
997 options->cipher_xform.cipher.algo = RTE_CRYPTO_CIPHER_AES_CBC;
998 options->cipher_xform.cipher.op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
1000 generate_random_key(options->ckey_data, sizeof(options->ckey_data));
1002 options->cipher_xform.cipher.key.data = options->ckey_data;
1003 options->cipher_xform.cipher.key.phys_addr = 0;
1004 options->cipher_xform.cipher.key.length = 16;
1007 /* Authentication Data */
1008 options->auth_xform.type = RTE_CRYPTO_XFORM_AUTH;
1009 options->auth_xform.next = NULL;
1011 options->auth_xform.auth.algo = RTE_CRYPTO_AUTH_SHA1_HMAC;
1012 options->auth_xform.auth.op = RTE_CRYPTO_AUTH_OP_VERIFY;
1014 options->auth_xform.auth.add_auth_data_length = 0;
1015 options->auth_xform.auth.digest_length = 20;
1017 generate_random_key(options->akey_data, sizeof(options->akey_data));
1019 options->auth_xform.auth.key.data = options->akey_data;
1020 options->auth_xform.auth.key.phys_addr = 0;
1021 options->auth_xform.auth.key.length = 20;
1025 /* Parse the argument given in the command line of the application */
1027 l2fwd_crypto_parse_args(struct l2fwd_crypto_options *options,
1028 int argc, char **argv)
1030 int opt, retval, option_index;
1031 char **argvopt = argv, *prgname = argv[0];
1033 static struct option lgopts[] = {
1034 { "sessionless", no_argument, 0, 0 },
1036 { "cdev_type", required_argument, 0, 0 },
1037 { "chain", required_argument, 0, 0 },
1039 { "cipher_algo", required_argument, 0, 0 },
1040 { "cipher_op", required_argument, 0, 0 },
1041 { "cipher_key", required_argument, 0, 0 },
1043 { "auth_algo", required_argument, 0, 0 },
1044 { "auth_op", required_argument, 0, 0 },
1045 { "auth_key", required_argument, 0, 0 },
1047 { "iv", required_argument, 0, 0 },
1049 { "sessionless", no_argument, 0, 0 },
1053 l2fwd_crypto_default_options(options);
1055 while ((opt = getopt_long(argc, argvopt, "p:q:st:", lgopts,
1056 &option_index)) != EOF) {
1060 retval = l2fwd_crypto_parse_args_long_options(options,
1061 lgopts, option_index);
1063 l2fwd_crypto_usage(prgname);
1070 retval = l2fwd_crypto_parse_portmask(options, optarg);
1072 l2fwd_crypto_usage(prgname);
1079 retval = l2fwd_crypto_parse_nqueue(options, optarg);
1081 l2fwd_crypto_usage(prgname);
1088 options->single_lcore = 1;
1094 retval = l2fwd_crypto_parse_timer_period(options,
1097 l2fwd_crypto_usage(prgname);
1103 l2fwd_crypto_usage(prgname);
1110 argv[optind-1] = prgname;
1113 optind = 0; /* reset getopt lib */
1118 /* Check the link status of all ports in up to 9s, and print them finally */
1120 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
1122 #define CHECK_INTERVAL 100 /* 100ms */
1123 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
1124 uint8_t portid, count, all_ports_up, print_flag = 0;
1125 struct rte_eth_link link;
1127 printf("\nChecking link status");
1129 for (count = 0; count <= MAX_CHECK_TIME; count++) {
1131 for (portid = 0; portid < port_num; portid++) {
1132 if ((port_mask & (1 << portid)) == 0)
1134 memset(&link, 0, sizeof(link));
1135 rte_eth_link_get_nowait(portid, &link);
1136 /* print link status if flag set */
1137 if (print_flag == 1) {
1138 if (link.link_status)
1139 printf("Port %d Link Up - speed %u "
1140 "Mbps - %s\n", (uint8_t)portid,
1141 (unsigned)link.link_speed,
1142 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
1143 ("full-duplex") : ("half-duplex\n"));
1145 printf("Port %d Link Down\n",
1149 /* clear all_ports_up flag if any link down */
1150 if (link.link_status == 0) {
1155 /* after finally printing all link status, get out */
1156 if (print_flag == 1)
1159 if (all_ports_up == 0) {
1162 rte_delay_ms(CHECK_INTERVAL);
1165 /* set the print_flag if all ports up or timeout */
1166 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
1174 initialize_cryptodevs(struct l2fwd_crypto_options *options, unsigned nb_ports)
1176 unsigned i, cdev_id, cdev_count, enabled_cdev_count = 0;
1179 if (options->cdev_type == RTE_CRYPTODEV_QAT_SYM_PMD) {
1180 if (rte_cryptodev_count() < nb_ports)
1182 } else if (options->cdev_type == RTE_CRYPTODEV_AESNI_MB_PMD) {
1183 for (i = 0; i < nb_ports; i++) {
1184 int retval = rte_eal_vdev_init(CRYPTODEV_NAME_AESNI_MB_PMD,
1191 cdev_count = rte_cryptodev_count();
1193 cdev_id < cdev_count && enabled_cdev_count < nb_ports;
1195 struct rte_cryptodev_qp_conf qp_conf;
1196 struct rte_cryptodev_info dev_info;
1198 struct rte_cryptodev_config conf = {
1199 .nb_queue_pairs = 1,
1200 .socket_id = SOCKET_ID_ANY,
1207 rte_cryptodev_info_get(cdev_id, &dev_info);
1209 if (dev_info.dev_type != options->cdev_type)
1213 retval = rte_cryptodev_configure(cdev_id, &conf);
1215 printf("Failed to configure cryptodev %u", cdev_id);
1219 qp_conf.nb_descriptors = 2048;
1221 retval = rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf,
1224 printf("Failed to setup queue pair %u on cryptodev %u",
1229 l2fwd_enabled_crypto_mask |= (1 << cdev_id);
1231 enabled_cdev_count++;
1234 return enabled_cdev_count;
1238 initialize_ports(struct l2fwd_crypto_options *options)
1240 uint8_t last_portid, portid;
1241 unsigned enabled_portcount = 0;
1242 unsigned nb_ports = rte_eth_dev_count();
1244 if (nb_ports == 0) {
1245 printf("No Ethernet ports - bye\n");
1249 if (nb_ports > RTE_MAX_ETHPORTS)
1250 nb_ports = RTE_MAX_ETHPORTS;
1252 /* Reset l2fwd_dst_ports */
1253 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
1254 l2fwd_dst_ports[portid] = 0;
1256 for (last_portid = 0, portid = 0; portid < nb_ports; portid++) {
1259 /* Skip ports that are not enabled */
1260 if ((options->portmask & (1 << portid)) == 0)
1264 printf("Initializing port %u... ", (unsigned) portid);
1266 retval = rte_eth_dev_configure(portid, 1, 1, &port_conf);
1268 printf("Cannot configure device: err=%d, port=%u\n",
1269 retval, (unsigned) portid);
1273 /* init one RX queue */
1275 retval = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
1276 rte_eth_dev_socket_id(portid),
1277 NULL, l2fwd_pktmbuf_pool);
1279 printf("rte_eth_rx_queue_setup:err=%d, port=%u\n",
1280 retval, (unsigned) portid);
1284 /* init one TX queue on each port */
1286 retval = rte_eth_tx_queue_setup(portid, 0, nb_txd,
1287 rte_eth_dev_socket_id(portid),
1290 printf("rte_eth_tx_queue_setup:err=%d, port=%u\n",
1291 retval, (unsigned) portid);
1297 retval = rte_eth_dev_start(portid);
1299 printf("rte_eth_dev_start:err=%d, port=%u\n",
1300 retval, (unsigned) portid);
1304 rte_eth_promiscuous_enable(portid);
1306 rte_eth_macaddr_get(portid, &l2fwd_ports_eth_addr[portid]);
1308 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
1310 l2fwd_ports_eth_addr[portid].addr_bytes[0],
1311 l2fwd_ports_eth_addr[portid].addr_bytes[1],
1312 l2fwd_ports_eth_addr[portid].addr_bytes[2],
1313 l2fwd_ports_eth_addr[portid].addr_bytes[3],
1314 l2fwd_ports_eth_addr[portid].addr_bytes[4],
1315 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
1317 /* initialize port stats */
1318 memset(&port_statistics, 0, sizeof(port_statistics));
1320 /* Setup port forwarding table */
1321 if (enabled_portcount % 2) {
1322 l2fwd_dst_ports[portid] = last_portid;
1323 l2fwd_dst_ports[last_portid] = portid;
1325 last_portid = portid;
1328 l2fwd_enabled_port_mask |= (1 << portid);
1329 enabled_portcount++;
1332 if (enabled_portcount == 1) {
1333 l2fwd_dst_ports[last_portid] = last_portid;
1334 } else if (enabled_portcount % 2) {
1335 printf("odd number of ports in portmask- bye\n");
1339 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
1341 return enabled_portcount;
1345 main(int argc, char **argv)
1347 struct lcore_queue_conf *qconf;
1348 struct l2fwd_crypto_options options;
1350 uint8_t nb_ports, nb_cryptodevs, portid, cdev_id;
1351 unsigned lcore_id, rx_lcore_id;
1352 int ret, enabled_cdevcount, enabled_portcount;
1355 ret = rte_eal_init(argc, argv);
1357 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
1361 /* parse application arguments (after the EAL ones) */
1362 ret = l2fwd_crypto_parse_args(&options, argc, argv);
1364 rte_exit(EXIT_FAILURE, "Invalid L2FWD-CRYPTO arguments\n");
1366 /* create the mbuf pool */
1367 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF, 128,
1368 0, RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
1369 if (l2fwd_pktmbuf_pool == NULL)
1370 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
1372 /* create crypto op pool */
1373 l2fwd_mbuf_ol_pool = rte_pktmbuf_offload_pool_create(
1374 "mbuf_offload_pool", NB_MBUF, 128, 0, rte_socket_id());
1375 if (l2fwd_mbuf_ol_pool == NULL)
1376 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
1378 /* Enable Ethernet ports */
1379 enabled_portcount = initialize_ports(&options);
1380 if (enabled_portcount < 1)
1381 rte_exit(EXIT_FAILURE, "Failed to initial Ethernet ports\n");
1383 nb_ports = rte_eth_dev_count();
1384 /* Initialize the port/queue configuration of each logical core */
1385 for (rx_lcore_id = 0, qconf = NULL, portid = 0;
1386 portid < nb_ports; portid++) {
1388 /* skip ports that are not enabled */
1389 if ((options.portmask & (1 << portid)) == 0)
1392 if (options.single_lcore && qconf == NULL) {
1393 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
1395 if (rx_lcore_id >= RTE_MAX_LCORE)
1396 rte_exit(EXIT_FAILURE,
1397 "Not enough cores\n");
1399 } else if (!options.single_lcore) {
1400 /* get the lcore_id for this port */
1401 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
1402 lcore_queue_conf[rx_lcore_id].nb_rx_ports ==
1403 options.nb_ports_per_lcore) {
1405 if (rx_lcore_id >= RTE_MAX_LCORE)
1406 rte_exit(EXIT_FAILURE,
1407 "Not enough cores\n");
1411 /* Assigned a new logical core in the loop above. */
1412 if (qconf != &lcore_queue_conf[rx_lcore_id])
1413 qconf = &lcore_queue_conf[rx_lcore_id];
1415 qconf->rx_port_list[qconf->nb_rx_ports] = portid;
1416 qconf->nb_rx_ports++;
1418 printf("Lcore %u: RX port %u\n", rx_lcore_id, (unsigned)portid);
1422 /* Enable Crypto devices */
1423 enabled_cdevcount = initialize_cryptodevs(&options, enabled_portcount);
1424 if (enabled_cdevcount < 1)
1425 rte_exit(EXIT_FAILURE, "Failed to initial crypto devices\n");
1427 nb_cryptodevs = rte_cryptodev_count();
1428 /* Initialize the port/queue configuration of each logical core */
1429 for (rx_lcore_id = 0, qconf = NULL, cdev_id = 0;
1430 cdev_id < nb_cryptodevs && enabled_cdevcount;
1432 struct rte_cryptodev_info info;
1434 rte_cryptodev_info_get(cdev_id, &info);
1436 /* skip devices of the wrong type */
1437 if (options.cdev_type != info.dev_type)
1440 if (options.single_lcore && qconf == NULL) {
1441 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
1443 if (rx_lcore_id >= RTE_MAX_LCORE)
1444 rte_exit(EXIT_FAILURE,
1445 "Not enough cores\n");
1447 } else if (!options.single_lcore) {
1448 /* get the lcore_id for this port */
1449 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
1450 lcore_queue_conf[rx_lcore_id].nb_crypto_devs ==
1451 options.nb_ports_per_lcore) {
1453 if (rx_lcore_id >= RTE_MAX_LCORE)
1454 rte_exit(EXIT_FAILURE,
1455 "Not enough cores\n");
1459 /* Assigned a new logical core in the loop above. */
1460 if (qconf != &lcore_queue_conf[rx_lcore_id])
1461 qconf = &lcore_queue_conf[rx_lcore_id];
1463 qconf->cryptodev_list[qconf->nb_crypto_devs] = cdev_id;
1464 qconf->nb_crypto_devs++;
1466 enabled_cdevcount--;
1468 printf("Lcore %u: cryptodev %u\n", rx_lcore_id,
1474 /* launch per-lcore init on every lcore */
1475 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, (void *)&options,
1477 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
1478 if (rte_eal_wait_lcore(lcore_id) < 0)