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_memcpy.h>
66 #include <rte_memory.h>
67 #include <rte_mempool.h>
68 #include <rte_memzone.h>
70 #include <rte_per_lcore.h>
71 #include <rte_prefetch.h>
72 #include <rte_random.h>
75 #define RTE_LOGTYPE_L2FWD RTE_LOGTYPE_USER1
79 #define MAX_PKT_BURST 32
80 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
83 * Configurable number of RX/TX ring descriptors
85 #define RTE_TEST_RX_DESC_DEFAULT 128
86 #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];
109 struct rte_crypto_op *buffer[MAX_PKT_BURST];
112 #define MAX_RX_QUEUE_PER_LCORE 16
113 #define MAX_TX_QUEUE_PER_PORT 16
115 enum l2fwd_crypto_xform_chain {
116 L2FWD_CRYPTO_CIPHER_HASH,
117 L2FWD_CRYPTO_HASH_CIPHER
123 phys_addr_t phys_addr;
126 /** l2fwd crypto application command line options */
127 struct l2fwd_crypto_options {
129 unsigned nb_ports_per_lcore;
130 unsigned refresh_period;
131 unsigned single_lcore:1;
133 enum rte_cryptodev_type cdev_type;
134 unsigned sessionless:1;
136 enum l2fwd_crypto_xform_chain xform_chain;
138 struct rte_crypto_sym_xform cipher_xform;
139 uint8_t ckey_data[32];
141 struct l2fwd_key iv_key;
142 uint8_t ivkey_data[16];
144 struct rte_crypto_sym_xform auth_xform;
145 uint8_t akey_data[128];
148 /** l2fwd crypto lcore params */
149 struct l2fwd_crypto_params {
153 unsigned digest_length;
155 struct l2fwd_key iv_key;
156 struct rte_cryptodev_sym_session *session;
159 /** lcore configuration */
160 struct lcore_queue_conf {
161 unsigned nb_rx_ports;
162 unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
164 unsigned nb_crypto_devs;
165 unsigned cryptodev_list[MAX_RX_QUEUE_PER_LCORE];
167 struct op_buffer op_buf[RTE_MAX_ETHPORTS];
168 struct pkt_buffer pkt_buf[RTE_MAX_ETHPORTS];
169 } __rte_cache_aligned;
171 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
173 static const struct rte_eth_conf port_conf = {
176 .header_split = 0, /**< Header Split disabled */
177 .hw_ip_checksum = 0, /**< IP checksum offload disabled */
178 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
179 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
180 .hw_strip_crc = 0, /**< CRC stripped by hardware */
183 .mq_mode = ETH_MQ_TX_NONE,
187 struct rte_mempool *l2fwd_pktmbuf_pool;
188 struct rte_mempool *l2fwd_crypto_op_pool;
190 /* Per-port statistics struct */
191 struct l2fwd_port_statistics {
195 uint64_t crypto_enqueued;
196 uint64_t crypto_dequeued;
199 } __rte_cache_aligned;
201 struct l2fwd_crypto_statistics {
206 } __rte_cache_aligned;
208 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
209 struct l2fwd_crypto_statistics crypto_statistics[RTE_MAX_ETHPORTS];
211 /* A tsc-based timer responsible for triggering statistics printout */
212 #define TIMER_MILLISECOND 2000000ULL /* around 1ms at 2 Ghz */
213 #define MAX_TIMER_PERIOD 86400UL /* 1 day max */
215 /* default period is 10 seconds */
216 static int64_t timer_period = 10 * TIMER_MILLISECOND * 1000;
218 /* Print out statistics on packets dropped */
222 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
223 uint64_t total_packets_enqueued, total_packets_dequeued,
224 total_packets_errors;
228 total_packets_dropped = 0;
229 total_packets_tx = 0;
230 total_packets_rx = 0;
231 total_packets_enqueued = 0;
232 total_packets_dequeued = 0;
233 total_packets_errors = 0;
235 const char clr[] = { 27, '[', '2', 'J', '\0' };
236 const char topLeft[] = { 27, '[', '1', ';', '1', 'H', '\0' };
238 /* Clear screen and move to top left */
239 printf("%s%s", clr, topLeft);
241 printf("\nPort statistics ====================================");
243 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
244 /* skip disabled ports */
245 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
247 printf("\nStatistics for port %u ------------------------------"
248 "\nPackets sent: %32"PRIu64
249 "\nPackets received: %28"PRIu64
250 "\nPackets dropped: %29"PRIu64,
252 port_statistics[portid].tx,
253 port_statistics[portid].rx,
254 port_statistics[portid].dropped);
256 total_packets_dropped += port_statistics[portid].dropped;
257 total_packets_tx += port_statistics[portid].tx;
258 total_packets_rx += port_statistics[portid].rx;
260 printf("\nCrypto statistics ==================================");
262 for (cdevid = 0; cdevid < RTE_CRYPTO_MAX_DEVS; cdevid++) {
263 /* skip disabled ports */
264 if ((l2fwd_enabled_crypto_mask & (1lu << cdevid)) == 0)
266 printf("\nStatistics for cryptodev %"PRIu64
267 " -------------------------"
268 "\nPackets enqueued: %28"PRIu64
269 "\nPackets dequeued: %28"PRIu64
270 "\nPackets errors: %30"PRIu64,
272 crypto_statistics[cdevid].enqueued,
273 crypto_statistics[cdevid].dequeued,
274 crypto_statistics[cdevid].errors);
276 total_packets_enqueued += crypto_statistics[cdevid].enqueued;
277 total_packets_dequeued += crypto_statistics[cdevid].dequeued;
278 total_packets_errors += crypto_statistics[cdevid].errors;
280 printf("\nAggregate statistics ==============================="
281 "\nTotal packets received: %22"PRIu64
282 "\nTotal packets enqueued: %22"PRIu64
283 "\nTotal packets dequeued: %22"PRIu64
284 "\nTotal packets sent: %26"PRIu64
285 "\nTotal packets dropped: %23"PRIu64
286 "\nTotal packets crypto errors: %17"PRIu64,
288 total_packets_enqueued,
289 total_packets_dequeued,
291 total_packets_dropped,
292 total_packets_errors);
293 printf("\n====================================================\n");
299 l2fwd_crypto_send_burst(struct lcore_queue_conf *qconf, unsigned n,
300 struct l2fwd_crypto_params *cparams)
302 struct rte_crypto_op **op_buffer;
305 op_buffer = (struct rte_crypto_op **)
306 qconf->op_buf[cparams->dev_id].buffer;
308 ret = rte_cryptodev_enqueue_burst(cparams->dev_id,
309 cparams->qp_id, op_buffer, (uint16_t) n);
311 crypto_statistics[cparams->dev_id].enqueued += ret;
312 if (unlikely(ret < n)) {
313 crypto_statistics[cparams->dev_id].errors += (n - ret);
315 rte_pktmbuf_free(op_buffer[ret]->sym->m_src);
316 rte_crypto_op_free(op_buffer[ret]);
324 l2fwd_crypto_enqueue(struct rte_crypto_op *op,
325 struct l2fwd_crypto_params *cparams)
327 unsigned lcore_id, len;
328 struct lcore_queue_conf *qconf;
330 lcore_id = rte_lcore_id();
332 qconf = &lcore_queue_conf[lcore_id];
333 len = qconf->op_buf[cparams->dev_id].len;
334 qconf->op_buf[cparams->dev_id].buffer[len] = op;
337 /* enough ops to be sent */
338 if (len == MAX_PKT_BURST) {
339 l2fwd_crypto_send_burst(qconf, MAX_PKT_BURST, cparams);
343 qconf->op_buf[cparams->dev_id].len = len;
348 l2fwd_simple_crypto_enqueue(struct rte_mbuf *m,
349 struct rte_crypto_op *op,
350 struct l2fwd_crypto_params *cparams)
352 struct ether_hdr *eth_hdr;
353 struct ipv4_hdr *ip_hdr;
355 unsigned ipdata_offset, pad_len, data_len;
358 eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
360 if (eth_hdr->ether_type != rte_cpu_to_be_16(ETHER_TYPE_IPv4))
363 ipdata_offset = sizeof(struct ether_hdr);
365 ip_hdr = (struct ipv4_hdr *)(rte_pktmbuf_mtod(m, char *) +
368 ipdata_offset += (ip_hdr->version_ihl & IPV4_HDR_IHL_MASK)
369 * IPV4_IHL_MULTIPLIER;
372 /* Zero pad data to be crypto'd so it is block aligned */
373 data_len = rte_pktmbuf_data_len(m) - ipdata_offset;
374 pad_len = data_len % cparams->block_size ? cparams->block_size -
375 (data_len % cparams->block_size) : 0;
378 padding = rte_pktmbuf_append(m, pad_len);
379 if (unlikely(!padding))
383 memset(padding, 0, pad_len);
386 /* Set crypto operation data parameters */
387 rte_crypto_op_attach_sym_session(op, cparams->session);
389 /* Append space for digest to end of packet */
390 op->sym->auth.digest.data = (uint8_t *)rte_pktmbuf_append(m,
391 cparams->digest_length);
392 op->sym->auth.digest.phys_addr = rte_pktmbuf_mtophys_offset(m,
393 rte_pktmbuf_pkt_len(m) - cparams->digest_length);
394 op->sym->auth.digest.length = cparams->digest_length;
396 op->sym->auth.data.offset = ipdata_offset;
397 op->sym->auth.data.length = data_len;
400 op->sym->cipher.iv.data = cparams->iv_key.data;
401 op->sym->cipher.iv.phys_addr = cparams->iv_key.phys_addr;
402 op->sym->cipher.iv.length = cparams->iv_key.length;
404 op->sym->cipher.data.offset = ipdata_offset;
405 op->sym->cipher.data.length = data_len;
409 return l2fwd_crypto_enqueue(op, cparams);
413 /* Send the burst of packets on an output interface */
415 l2fwd_send_burst(struct lcore_queue_conf *qconf, unsigned n,
418 struct rte_mbuf **pkt_buffer;
421 pkt_buffer = (struct rte_mbuf **)qconf->pkt_buf[port].buffer;
423 ret = rte_eth_tx_burst(port, 0, pkt_buffer, (uint16_t)n);
424 port_statistics[port].tx += ret;
425 if (unlikely(ret < n)) {
426 port_statistics[port].dropped += (n - ret);
428 rte_pktmbuf_free(pkt_buffer[ret]);
435 /* Enqueue packets for TX and prepare them to be sent */
437 l2fwd_send_packet(struct rte_mbuf *m, uint8_t port)
439 unsigned lcore_id, len;
440 struct lcore_queue_conf *qconf;
442 lcore_id = rte_lcore_id();
444 qconf = &lcore_queue_conf[lcore_id];
445 len = qconf->pkt_buf[port].len;
446 qconf->pkt_buf[port].buffer[len] = m;
449 /* enough pkts to be sent */
450 if (unlikely(len == MAX_PKT_BURST)) {
451 l2fwd_send_burst(qconf, MAX_PKT_BURST, port);
455 qconf->pkt_buf[port].len = len;
460 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
462 struct ether_hdr *eth;
466 dst_port = l2fwd_dst_ports[portid];
467 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
469 /* 02:00:00:00:00:xx */
470 tmp = ð->d_addr.addr_bytes[0];
471 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dst_port << 40);
474 ether_addr_copy(&l2fwd_ports_eth_addr[dst_port], ð->s_addr);
476 l2fwd_send_packet(m, (uint8_t) dst_port);
479 /** Generate random key */
481 generate_random_key(uint8_t *key, unsigned length)
485 for (i = 0; i < length; i++)
486 key[i] = rand() % 0xff;
489 static struct rte_cryptodev_sym_session *
490 initialize_crypto_session(struct l2fwd_crypto_options *options,
493 struct rte_crypto_sym_xform *first_xform;
495 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH) {
496 first_xform = &options->cipher_xform;
497 first_xform->next = &options->auth_xform;
499 first_xform = &options->auth_xform;
500 first_xform->next = &options->cipher_xform;
503 /* Setup Cipher Parameters */
504 return rte_cryptodev_sym_session_create(cdev_id, first_xform);
508 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options);
510 /* main processing loop */
512 l2fwd_main_loop(struct l2fwd_crypto_options *options)
514 struct rte_mbuf *m, *pkts_burst[MAX_PKT_BURST];
515 struct rte_crypto_op *ops_burst[MAX_PKT_BURST];
517 unsigned lcore_id = rte_lcore_id();
518 uint64_t prev_tsc = 0, diff_tsc, cur_tsc, timer_tsc = 0;
519 unsigned i, j, portid, nb_rx;
520 struct lcore_queue_conf *qconf = &lcore_queue_conf[lcore_id];
521 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) /
522 US_PER_S * BURST_TX_DRAIN_US;
523 struct l2fwd_crypto_params *cparams;
524 struct l2fwd_crypto_params port_cparams[qconf->nb_crypto_devs];
526 if (qconf->nb_rx_ports == 0) {
527 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
531 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
533 l2fwd_crypto_options_print(options);
535 for (i = 0; i < qconf->nb_rx_ports; i++) {
537 portid = qconf->rx_port_list[i];
538 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
542 for (i = 0; i < qconf->nb_crypto_devs; i++) {
543 port_cparams[i].dev_id = qconf->cryptodev_list[i];
544 port_cparams[i].qp_id = 0;
546 port_cparams[i].block_size = 64;
547 port_cparams[i].digest_length = 20;
549 port_cparams[i].iv_key.data =
550 (uint8_t *)rte_malloc(NULL, 16, 8);
551 port_cparams[i].iv_key.length = 16;
552 port_cparams[i].iv_key.phys_addr = rte_malloc_virt2phy(
553 (void *)port_cparams[i].iv_key.data);
554 generate_random_key(port_cparams[i].iv_key.data,
555 sizeof(cparams[i].iv_key.length));
557 port_cparams[i].session = initialize_crypto_session(options,
558 port_cparams[i].dev_id);
560 if (port_cparams[i].session == NULL)
562 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u cryptoid=%u\n", lcore_id,
563 port_cparams[i].dev_id);
568 cur_tsc = rte_rdtsc();
571 * TX burst queue drain
573 diff_tsc = cur_tsc - prev_tsc;
574 if (unlikely(diff_tsc > drain_tsc)) {
576 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
577 if (qconf->pkt_buf[portid].len == 0)
579 l2fwd_send_burst(&lcore_queue_conf[lcore_id],
580 qconf->pkt_buf[portid].len,
582 qconf->pkt_buf[portid].len = 0;
585 /* if timer is enabled */
586 if (timer_period > 0) {
588 /* advance the timer */
589 timer_tsc += diff_tsc;
591 /* if timer has reached its timeout */
592 if (unlikely(timer_tsc >=
593 (uint64_t)timer_period)) {
595 /* do this only on master core */
596 if (lcore_id == rte_get_master_lcore()
597 && options->refresh_period) {
608 * Read packet from RX queues
610 for (i = 0; i < qconf->nb_rx_ports; i++) {
611 portid = qconf->rx_port_list[i];
613 cparams = &port_cparams[i];
615 nb_rx = rte_eth_rx_burst((uint8_t) portid, 0,
616 pkts_burst, MAX_PKT_BURST);
618 port_statistics[portid].rx += nb_rx;
622 * If we can't allocate a crypto_ops, then drop
623 * the rest of the burst and dequeue and
624 * process the packets to free offload structs
626 if (rte_crypto_op_bulk_alloc(
627 l2fwd_crypto_op_pool,
628 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
631 for (j = 0; j < nb_rx; j++)
632 rte_pktmbuf_free(pkts_burst[i]);
637 /* Enqueue packets from Crypto device*/
638 for (j = 0; j < nb_rx; j++) {
641 l2fwd_simple_crypto_enqueue(m,
642 ops_burst[j], cparams);
646 /* Dequeue packets from Crypto device */
648 nb_rx = rte_cryptodev_dequeue_burst(
649 cparams->dev_id, cparams->qp_id,
650 ops_burst, MAX_PKT_BURST);
652 crypto_statistics[cparams->dev_id].dequeued +=
655 /* Forward crypto'd packets */
656 for (j = 0; j < nb_rx; j++) {
657 m = ops_burst[j]->sym->m_src;
659 rte_crypto_op_free(ops_burst[j]);
660 l2fwd_simple_forward(m, portid);
662 } while (nb_rx == MAX_PKT_BURST);
668 l2fwd_launch_one_lcore(void *arg)
670 l2fwd_main_loop((struct l2fwd_crypto_options *)arg);
674 /* Display command line arguments usage */
676 l2fwd_crypto_usage(const char *prgname)
678 printf("%s [EAL options] -- --cdev TYPE [optional parameters]\n"
679 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
680 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
681 " -s manage all ports from single lcore"
682 " -t PERIOD: statistics will be refreshed each PERIOD seconds"
683 " (0 to disable, 10 default, 86400 maximum)\n"
685 " --cdev AESNI_MB / QAT\n"
686 " --chain HASH_CIPHER / CIPHER_HASH\n"
688 " --cipher_algo ALGO\n"
689 " --cipher_op ENCRYPT / DECRYPT\n"
690 " --cipher_key KEY\n"
693 " --auth_algo ALGO\n"
694 " --auth_op GENERATE / VERIFY\n"
701 /** Parse crypto device type command line argument */
703 parse_cryptodev_type(enum rte_cryptodev_type *type, char *optarg)
705 if (strcmp("AESNI_MB", optarg) == 0) {
706 *type = RTE_CRYPTODEV_AESNI_MB_PMD;
708 } else if (strcmp("QAT", optarg) == 0) {
709 *type = RTE_CRYPTODEV_QAT_SYM_PMD;
716 /** Parse crypto chain xform command line argument */
718 parse_crypto_opt_chain(struct l2fwd_crypto_options *options, char *optarg)
720 if (strcmp("CIPHER_HASH", optarg) == 0) {
721 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
723 } else if (strcmp("HASH_CIPHER", optarg) == 0) {
724 options->xform_chain = L2FWD_CRYPTO_HASH_CIPHER;
731 /** Parse crypto cipher algo option command line argument */
733 parse_cipher_algo(enum rte_crypto_cipher_algorithm *algo, char *optarg)
735 if (strcmp("AES_CBC", optarg) == 0) {
736 *algo = RTE_CRYPTO_CIPHER_AES_CBC;
738 } else if (strcmp("AES_GCM", optarg) == 0) {
739 *algo = RTE_CRYPTO_CIPHER_AES_GCM;
743 printf("Cipher algorithm not supported!\n");
747 /** Parse crypto cipher operation command line argument */
749 parse_cipher_op(enum rte_crypto_cipher_operation *op, char *optarg)
751 if (strcmp("ENCRYPT", optarg) == 0) {
752 *op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
754 } else if (strcmp("DECRYPT", optarg) == 0) {
755 *op = RTE_CRYPTO_CIPHER_OP_DECRYPT;
759 printf("Cipher operation not supported!\n");
763 /** Parse crypto key command line argument */
765 parse_key(struct l2fwd_key *key __rte_unused,
766 unsigned length __rte_unused, char *arg __rte_unused)
768 printf("Currently an unsupported argument!\n");
772 /** Parse crypto cipher operation command line argument */
774 parse_auth_algo(enum rte_crypto_auth_algorithm *algo, char *optarg)
776 if (strcmp("MD5_HMAC", optarg) == 0) {
777 *algo = RTE_CRYPTO_AUTH_MD5_HMAC;
779 } else if (strcmp("SHA1_HMAC", optarg) == 0) {
780 *algo = RTE_CRYPTO_AUTH_SHA1_HMAC;
782 } else if (strcmp("SHA224_HMAC", optarg) == 0) {
783 *algo = RTE_CRYPTO_AUTH_SHA224_HMAC;
785 } else if (strcmp("SHA256_HMAC", optarg) == 0) {
786 *algo = RTE_CRYPTO_AUTH_SHA256_HMAC;
788 } else if (strcmp("SHA384_HMAC", optarg) == 0) {
789 *algo = RTE_CRYPTO_AUTH_SHA384_HMAC;
791 } else if (strcmp("SHA512_HMAC", optarg) == 0) {
792 *algo = RTE_CRYPTO_AUTH_SHA512_HMAC;
796 printf("Authentication algorithm specified not supported!\n");
801 parse_auth_op(enum rte_crypto_auth_operation *op, char *optarg)
803 if (strcmp("VERIFY", optarg) == 0) {
804 *op = RTE_CRYPTO_AUTH_OP_VERIFY;
806 } else if (strcmp("GENERATE", optarg) == 0) {
807 *op = RTE_CRYPTO_AUTH_OP_GENERATE;
811 printf("Authentication operation specified not supported!\n");
815 /** Parse long options */
817 l2fwd_crypto_parse_args_long_options(struct l2fwd_crypto_options *options,
818 struct option *lgopts, int option_index)
820 if (strcmp(lgopts[option_index].name, "cdev_type") == 0)
821 return parse_cryptodev_type(&options->cdev_type, optarg);
823 else if (strcmp(lgopts[option_index].name, "chain") == 0)
824 return parse_crypto_opt_chain(options, optarg);
827 else if (strcmp(lgopts[option_index].name, "cipher_algo") == 0)
828 return parse_cipher_algo(&options->cipher_xform.cipher.algo,
831 else if (strcmp(lgopts[option_index].name, "cipher_op") == 0)
832 return parse_cipher_op(&options->cipher_xform.cipher.op,
835 else if (strcmp(lgopts[option_index].name, "cipher_key") == 0) {
836 struct l2fwd_key key = { 0 };
839 retval = parse_key(&key, sizeof(options->ckey_data), optarg);
841 options->cipher_xform.cipher.key.data = key.data;
842 options->cipher_xform.cipher.key.length = key.length;
845 } else if (strcmp(lgopts[option_index].name, "iv") == 0)
846 return parse_key(&options->iv_key, sizeof(options->ivkey_data),
849 /* Authentication options */
850 else if (strcmp(lgopts[option_index].name, "auth_algo") == 0)
851 return parse_auth_algo(&options->auth_xform.auth.algo,
854 else if (strcmp(lgopts[option_index].name, "auth_op") == 0)
855 return parse_auth_op(&options->auth_xform.auth.op,
858 else if (strcmp(lgopts[option_index].name, "auth_key") == 0) {
859 struct l2fwd_key key = { 0 };
862 retval = parse_key(&key, sizeof(options->akey_data), optarg);
864 options->auth_xform.auth.key.data = key.data;
865 options->auth_xform.auth.key.length = key.length;
868 } else if (strcmp(lgopts[option_index].name, "sessionless") == 0) {
869 options->sessionless = 1;
876 /** Parse port mask */
878 l2fwd_crypto_parse_portmask(struct l2fwd_crypto_options *options,
884 /* parse hexadecimal string */
885 pm = strtoul(q_arg, &end, 16);
886 if ((pm == '\0') || (end == NULL) || (*end != '\0'))
889 options->portmask = pm;
890 if (options->portmask == 0) {
891 printf("invalid portmask specified\n");
898 /** Parse number of queues */
900 l2fwd_crypto_parse_nqueue(struct l2fwd_crypto_options *options,
906 /* parse hexadecimal string */
907 n = strtoul(q_arg, &end, 10);
908 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
910 else if (n >= MAX_RX_QUEUE_PER_LCORE)
913 options->nb_ports_per_lcore = n;
914 if (options->nb_ports_per_lcore == 0) {
915 printf("invalid number of ports selected\n");
922 /** Parse timer period */
924 l2fwd_crypto_parse_timer_period(struct l2fwd_crypto_options *options,
930 /* parse number string */
931 n = (unsigned)strtol(q_arg, &end, 10);
932 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
935 if (n >= MAX_TIMER_PERIOD) {
936 printf("Warning refresh period specified %lu is greater than "
937 "max value %lu! using max value",
938 n, MAX_TIMER_PERIOD);
939 n = MAX_TIMER_PERIOD;
942 options->refresh_period = n * 1000 * TIMER_MILLISECOND;
947 /** Generate default options for application */
949 l2fwd_crypto_default_options(struct l2fwd_crypto_options *options)
953 options->portmask = 0xffffffff;
954 options->nb_ports_per_lcore = 1;
955 options->refresh_period = 10000;
956 options->single_lcore = 0;
957 options->sessionless = 0;
959 options->cdev_type = RTE_CRYPTODEV_AESNI_MB_PMD;
960 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
963 options->cipher_xform.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
964 options->cipher_xform.next = NULL;
966 options->cipher_xform.cipher.algo = RTE_CRYPTO_CIPHER_AES_CBC;
967 options->cipher_xform.cipher.op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
969 generate_random_key(options->ckey_data, sizeof(options->ckey_data));
971 options->cipher_xform.cipher.key.data = options->ckey_data;
972 options->cipher_xform.cipher.key.length = 16;
975 /* Authentication Data */
976 options->auth_xform.type = RTE_CRYPTO_SYM_XFORM_AUTH;
977 options->auth_xform.next = NULL;
979 options->auth_xform.auth.algo = RTE_CRYPTO_AUTH_SHA1_HMAC;
980 options->auth_xform.auth.op = RTE_CRYPTO_AUTH_OP_VERIFY;
982 options->auth_xform.auth.add_auth_data_length = 0;
983 options->auth_xform.auth.digest_length = 20;
985 generate_random_key(options->akey_data, sizeof(options->akey_data));
987 options->auth_xform.auth.key.data = options->akey_data;
988 options->auth_xform.auth.key.length = 20;
992 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options)
994 printf("Options:-\nn");
995 printf("portmask: %x\n", options->portmask);
996 printf("ports per lcore: %u\n", options->nb_ports_per_lcore);
997 printf("refresh period : %u\n", options->refresh_period);
998 printf("single lcore mode: %s\n",
999 options->single_lcore ? "enabled" : "disabled");
1000 printf("stats_printing: %s\n",
1001 options->refresh_period == 0 ? "disabled" : "enabled");
1003 switch (options->cdev_type) {
1004 case RTE_CRYPTODEV_AESNI_MB_PMD:
1005 printf("cryptodev type: AES-NI MB PMD\n"); break;
1006 case RTE_CRYPTODEV_QAT_SYM_PMD:
1007 printf("cryptodev type: QAT PMD\n"); break;
1012 printf("sessionless crypto: %s\n",
1013 options->sessionless ? "enabled" : "disabled");
1016 /* Parse the argument given in the command line of the application */
1018 l2fwd_crypto_parse_args(struct l2fwd_crypto_options *options,
1019 int argc, char **argv)
1021 int opt, retval, option_index;
1022 char **argvopt = argv, *prgname = argv[0];
1024 static struct option lgopts[] = {
1025 { "sessionless", no_argument, 0, 0 },
1027 { "cdev_type", required_argument, 0, 0 },
1028 { "chain", required_argument, 0, 0 },
1030 { "cipher_algo", required_argument, 0, 0 },
1031 { "cipher_op", required_argument, 0, 0 },
1032 { "cipher_key", required_argument, 0, 0 },
1034 { "auth_algo", required_argument, 0, 0 },
1035 { "auth_op", required_argument, 0, 0 },
1036 { "auth_key", required_argument, 0, 0 },
1038 { "iv", required_argument, 0, 0 },
1040 { "sessionless", no_argument, 0, 0 },
1045 l2fwd_crypto_default_options(options);
1047 while ((opt = getopt_long(argc, argvopt, "p:q:st:", lgopts,
1048 &option_index)) != EOF) {
1052 retval = l2fwd_crypto_parse_args_long_options(options,
1053 lgopts, option_index);
1055 l2fwd_crypto_usage(prgname);
1062 retval = l2fwd_crypto_parse_portmask(options, optarg);
1064 l2fwd_crypto_usage(prgname);
1071 retval = l2fwd_crypto_parse_nqueue(options, optarg);
1073 l2fwd_crypto_usage(prgname);
1080 options->single_lcore = 1;
1086 retval = l2fwd_crypto_parse_timer_period(options,
1089 l2fwd_crypto_usage(prgname);
1095 l2fwd_crypto_usage(prgname);
1102 argv[optind-1] = prgname;
1105 optind = 0; /* reset getopt lib */
1110 /* Check the link status of all ports in up to 9s, and print them finally */
1112 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
1114 #define CHECK_INTERVAL 100 /* 100ms */
1115 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
1116 uint8_t portid, count, all_ports_up, print_flag = 0;
1117 struct rte_eth_link link;
1119 printf("\nChecking link status");
1121 for (count = 0; count <= MAX_CHECK_TIME; count++) {
1123 for (portid = 0; portid < port_num; portid++) {
1124 if ((port_mask & (1 << portid)) == 0)
1126 memset(&link, 0, sizeof(link));
1127 rte_eth_link_get_nowait(portid, &link);
1128 /* print link status if flag set */
1129 if (print_flag == 1) {
1130 if (link.link_status)
1131 printf("Port %d Link Up - speed %u "
1132 "Mbps - %s\n", (uint8_t)portid,
1133 (unsigned)link.link_speed,
1134 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
1135 ("full-duplex") : ("half-duplex\n"));
1137 printf("Port %d Link Down\n",
1141 /* clear all_ports_up flag if any link down */
1142 if (link.link_status == 0) {
1147 /* after finally printing all link status, get out */
1148 if (print_flag == 1)
1151 if (all_ports_up == 0) {
1154 rte_delay_ms(CHECK_INTERVAL);
1157 /* set the print_flag if all ports up or timeout */
1158 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
1166 initialize_cryptodevs(struct l2fwd_crypto_options *options, unsigned nb_ports)
1168 unsigned i, cdev_id, cdev_count, enabled_cdev_count = 0;
1171 if (options->cdev_type == RTE_CRYPTODEV_QAT_SYM_PMD) {
1172 if (rte_cryptodev_count() < nb_ports)
1174 } else if (options->cdev_type == RTE_CRYPTODEV_AESNI_MB_PMD) {
1175 for (i = 0; i < nb_ports; i++) {
1176 int retval = rte_eal_vdev_init(CRYPTODEV_NAME_AESNI_MB_PMD,
1183 cdev_count = rte_cryptodev_count();
1185 cdev_id < cdev_count && enabled_cdev_count < nb_ports;
1187 struct rte_cryptodev_qp_conf qp_conf;
1188 struct rte_cryptodev_info dev_info;
1190 struct rte_cryptodev_config conf = {
1191 .nb_queue_pairs = 1,
1192 .socket_id = SOCKET_ID_ANY,
1199 rte_cryptodev_info_get(cdev_id, &dev_info);
1201 if (dev_info.dev_type != options->cdev_type)
1205 retval = rte_cryptodev_configure(cdev_id, &conf);
1207 printf("Failed to configure cryptodev %u", cdev_id);
1211 qp_conf.nb_descriptors = 2048;
1213 retval = rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf,
1216 printf("Failed to setup queue pair %u on cryptodev %u",
1221 l2fwd_enabled_crypto_mask |= (1 << cdev_id);
1223 enabled_cdev_count++;
1226 return enabled_cdev_count;
1230 initialize_ports(struct l2fwd_crypto_options *options)
1232 uint8_t last_portid, portid;
1233 unsigned enabled_portcount = 0;
1234 unsigned nb_ports = rte_eth_dev_count();
1236 if (nb_ports == 0) {
1237 printf("No Ethernet ports - bye\n");
1241 if (nb_ports > RTE_MAX_ETHPORTS)
1242 nb_ports = RTE_MAX_ETHPORTS;
1244 /* Reset l2fwd_dst_ports */
1245 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
1246 l2fwd_dst_ports[portid] = 0;
1248 for (last_portid = 0, portid = 0; portid < nb_ports; portid++) {
1251 /* Skip ports that are not enabled */
1252 if ((options->portmask & (1 << portid)) == 0)
1256 printf("Initializing port %u... ", (unsigned) portid);
1258 retval = rte_eth_dev_configure(portid, 1, 1, &port_conf);
1260 printf("Cannot configure device: err=%d, port=%u\n",
1261 retval, (unsigned) portid);
1265 /* init one RX queue */
1267 retval = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
1268 rte_eth_dev_socket_id(portid),
1269 NULL, l2fwd_pktmbuf_pool);
1271 printf("rte_eth_rx_queue_setup:err=%d, port=%u\n",
1272 retval, (unsigned) portid);
1276 /* init one TX queue on each port */
1278 retval = rte_eth_tx_queue_setup(portid, 0, nb_txd,
1279 rte_eth_dev_socket_id(portid),
1282 printf("rte_eth_tx_queue_setup:err=%d, port=%u\n",
1283 retval, (unsigned) portid);
1289 retval = rte_eth_dev_start(portid);
1291 printf("rte_eth_dev_start:err=%d, port=%u\n",
1292 retval, (unsigned) portid);
1296 rte_eth_promiscuous_enable(portid);
1298 rte_eth_macaddr_get(portid, &l2fwd_ports_eth_addr[portid]);
1300 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
1302 l2fwd_ports_eth_addr[portid].addr_bytes[0],
1303 l2fwd_ports_eth_addr[portid].addr_bytes[1],
1304 l2fwd_ports_eth_addr[portid].addr_bytes[2],
1305 l2fwd_ports_eth_addr[portid].addr_bytes[3],
1306 l2fwd_ports_eth_addr[portid].addr_bytes[4],
1307 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
1309 /* initialize port stats */
1310 memset(&port_statistics, 0, sizeof(port_statistics));
1312 /* Setup port forwarding table */
1313 if (enabled_portcount % 2) {
1314 l2fwd_dst_ports[portid] = last_portid;
1315 l2fwd_dst_ports[last_portid] = portid;
1317 last_portid = portid;
1320 l2fwd_enabled_port_mask |= (1 << portid);
1321 enabled_portcount++;
1324 if (enabled_portcount == 1) {
1325 l2fwd_dst_ports[last_portid] = last_portid;
1326 } else if (enabled_portcount % 2) {
1327 printf("odd number of ports in portmask- bye\n");
1331 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
1333 return enabled_portcount;
1337 main(int argc, char **argv)
1339 struct lcore_queue_conf *qconf;
1340 struct l2fwd_crypto_options options;
1342 uint8_t nb_ports, nb_cryptodevs, portid, cdev_id;
1343 unsigned lcore_id, rx_lcore_id;
1344 int ret, enabled_cdevcount, enabled_portcount;
1347 ret = rte_eal_init(argc, argv);
1349 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
1353 /* parse application arguments (after the EAL ones) */
1354 ret = l2fwd_crypto_parse_args(&options, argc, argv);
1356 rte_exit(EXIT_FAILURE, "Invalid L2FWD-CRYPTO arguments\n");
1358 /* create the mbuf pool */
1359 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF, 512,
1360 sizeof(struct rte_crypto_op),
1361 RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
1362 if (l2fwd_pktmbuf_pool == NULL)
1363 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
1365 /* create crypto op pool */
1366 l2fwd_crypto_op_pool = rte_crypto_op_pool_create("crypto_op_pool",
1367 RTE_CRYPTO_OP_TYPE_SYMMETRIC, NB_MBUF, 128, 0,
1369 if (l2fwd_crypto_op_pool == NULL)
1370 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
1372 /* Enable Ethernet ports */
1373 enabled_portcount = initialize_ports(&options);
1374 if (enabled_portcount < 1)
1375 rte_exit(EXIT_FAILURE, "Failed to initial Ethernet ports\n");
1377 nb_ports = rte_eth_dev_count();
1378 /* Initialize the port/queue configuration of each logical core */
1379 for (rx_lcore_id = 0, qconf = NULL, portid = 0;
1380 portid < nb_ports; portid++) {
1382 /* skip ports that are not enabled */
1383 if ((options.portmask & (1 << portid)) == 0)
1386 if (options.single_lcore && qconf == NULL) {
1387 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
1389 if (rx_lcore_id >= RTE_MAX_LCORE)
1390 rte_exit(EXIT_FAILURE,
1391 "Not enough cores\n");
1393 } else if (!options.single_lcore) {
1394 /* get the lcore_id for this port */
1395 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
1396 lcore_queue_conf[rx_lcore_id].nb_rx_ports ==
1397 options.nb_ports_per_lcore) {
1399 if (rx_lcore_id >= RTE_MAX_LCORE)
1400 rte_exit(EXIT_FAILURE,
1401 "Not enough cores\n");
1405 /* Assigned a new logical core in the loop above. */
1406 if (qconf != &lcore_queue_conf[rx_lcore_id])
1407 qconf = &lcore_queue_conf[rx_lcore_id];
1409 qconf->rx_port_list[qconf->nb_rx_ports] = portid;
1410 qconf->nb_rx_ports++;
1412 printf("Lcore %u: RX port %u\n", rx_lcore_id, (unsigned)portid);
1416 /* Enable Crypto devices */
1417 enabled_cdevcount = initialize_cryptodevs(&options, enabled_portcount);
1418 if (enabled_cdevcount < 1)
1419 rte_exit(EXIT_FAILURE, "Failed to initial crypto devices\n");
1421 nb_cryptodevs = rte_cryptodev_count();
1422 /* Initialize the port/queue configuration of each logical core */
1423 for (rx_lcore_id = 0, qconf = NULL, cdev_id = 0;
1424 cdev_id < nb_cryptodevs && enabled_cdevcount;
1426 struct rte_cryptodev_info info;
1428 rte_cryptodev_info_get(cdev_id, &info);
1430 /* skip devices of the wrong type */
1431 if (options.cdev_type != info.dev_type)
1434 if (options.single_lcore && qconf == NULL) {
1435 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
1437 if (rx_lcore_id >= RTE_MAX_LCORE)
1438 rte_exit(EXIT_FAILURE,
1439 "Not enough cores\n");
1441 } else if (!options.single_lcore) {
1442 /* get the lcore_id for this port */
1443 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
1444 lcore_queue_conf[rx_lcore_id].nb_crypto_devs ==
1445 options.nb_ports_per_lcore) {
1447 if (rx_lcore_id >= RTE_MAX_LCORE)
1448 rte_exit(EXIT_FAILURE,
1449 "Not enough cores\n");
1453 /* Assigned a new logical core in the loop above. */
1454 if (qconf != &lcore_queue_conf[rx_lcore_id])
1455 qconf = &lcore_queue_conf[rx_lcore_id];
1457 qconf->cryptodev_list[qconf->nb_crypto_devs] = cdev_id;
1458 qconf->nb_crypto_devs++;
1460 enabled_cdevcount--;
1462 printf("Lcore %u: cryptodev %u\n", rx_lcore_id,
1468 /* launch per-lcore init on every lcore */
1469 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, (void *)&options,
1471 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
1472 if (rte_eal_wait_lcore(lcore_id) < 0)