4 * Copyright(c) 2015-2017 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>
51 #include <rte_atomic.h>
52 #include <rte_branch_prediction.h>
53 #include <rte_common.h>
54 #include <rte_cryptodev.h>
55 #include <rte_cycles.h>
56 #include <rte_debug.h>
58 #include <rte_ether.h>
59 #include <rte_ethdev.h>
60 #include <rte_interrupts.h>
62 #include <rte_launch.h>
63 #include <rte_lcore.h>
65 #include <rte_malloc.h>
67 #include <rte_memcpy.h>
68 #include <rte_memory.h>
69 #include <rte_mempool.h>
70 #include <rte_memzone.h>
72 #include <rte_per_lcore.h>
73 #include <rte_prefetch.h>
74 #include <rte_random.h>
75 #include <rte_hexdump.h>
83 #define RTE_LOGTYPE_L2FWD RTE_LOGTYPE_USER1
87 #define MAX_STR_LEN 32
88 #define MAX_KEY_SIZE 128
89 #define MAX_PKT_BURST 32
90 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
92 #define MAXIMUM_IV_LENGTH 16
93 #define IV_OFFSET (sizeof(struct rte_crypto_op) + \
94 sizeof(struct rte_crypto_sym_op))
97 * Configurable number of RX/TX ring descriptors
99 #define RTE_TEST_RX_DESC_DEFAULT 128
100 #define RTE_TEST_TX_DESC_DEFAULT 512
102 static uint16_t nb_rxd = RTE_TEST_RX_DESC_DEFAULT;
103 static uint16_t nb_txd = RTE_TEST_TX_DESC_DEFAULT;
105 /* ethernet addresses of ports */
106 static struct ether_addr l2fwd_ports_eth_addr[RTE_MAX_ETHPORTS];
108 /* mask of enabled ports */
109 static uint64_t l2fwd_enabled_port_mask;
110 static uint64_t l2fwd_enabled_crypto_mask;
112 /* list of enabled ports */
113 static uint32_t l2fwd_dst_ports[RTE_MAX_ETHPORTS];
118 struct rte_mbuf *buffer[MAX_PKT_BURST];
123 struct rte_crypto_op *buffer[MAX_PKT_BURST];
126 #define MAX_RX_QUEUE_PER_LCORE 16
127 #define MAX_TX_QUEUE_PER_PORT 16
129 enum l2fwd_crypto_xform_chain {
130 L2FWD_CRYPTO_CIPHER_HASH,
131 L2FWD_CRYPTO_HASH_CIPHER,
132 L2FWD_CRYPTO_CIPHER_ONLY,
133 L2FWD_CRYPTO_HASH_ONLY
139 phys_addr_t phys_addr;
147 /** l2fwd crypto application command line options */
148 struct l2fwd_crypto_options {
150 unsigned nb_ports_per_lcore;
151 unsigned refresh_period;
152 unsigned single_lcore:1;
155 unsigned sessionless:1;
157 enum l2fwd_crypto_xform_chain xform_chain;
159 struct rte_crypto_sym_xform cipher_xform;
161 int ckey_random_size;
163 struct l2fwd_iv cipher_iv;
164 unsigned int cipher_iv_param;
165 int cipher_iv_random_size;
167 struct rte_crypto_sym_xform auth_xform;
169 int akey_random_size;
171 struct l2fwd_iv auth_iv;
172 unsigned int auth_iv_param;
173 int auth_iv_random_size;
175 struct l2fwd_key aad;
182 char string_type[MAX_STR_LEN];
184 uint64_t cryptodev_mask;
187 /** l2fwd crypto lcore params */
188 struct l2fwd_crypto_params {
192 unsigned digest_length;
195 struct l2fwd_iv cipher_iv;
196 struct l2fwd_iv auth_iv;
197 struct l2fwd_key aad;
198 struct rte_cryptodev_sym_session *session;
204 enum rte_crypto_cipher_algorithm cipher_algo;
205 enum rte_crypto_auth_algorithm auth_algo;
208 /** lcore configuration */
209 struct lcore_queue_conf {
210 unsigned nb_rx_ports;
211 unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
213 unsigned nb_crypto_devs;
214 unsigned cryptodev_list[MAX_RX_QUEUE_PER_LCORE];
216 struct op_buffer op_buf[RTE_CRYPTO_MAX_DEVS];
217 struct pkt_buffer pkt_buf[RTE_MAX_ETHPORTS];
218 } __rte_cache_aligned;
220 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
222 static const struct rte_eth_conf port_conf = {
224 .mq_mode = ETH_MQ_RX_NONE,
225 .max_rx_pkt_len = ETHER_MAX_LEN,
227 .header_split = 0, /**< Header Split disabled */
228 .hw_ip_checksum = 0, /**< IP checksum offload disabled */
229 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
230 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
231 .hw_strip_crc = 1, /**< CRC stripped by hardware */
234 .mq_mode = ETH_MQ_TX_NONE,
238 struct rte_mempool *l2fwd_pktmbuf_pool;
239 struct rte_mempool *l2fwd_crypto_op_pool;
241 /* Per-port statistics struct */
242 struct l2fwd_port_statistics {
246 uint64_t crypto_enqueued;
247 uint64_t crypto_dequeued;
250 } __rte_cache_aligned;
252 struct l2fwd_crypto_statistics {
257 } __rte_cache_aligned;
259 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
260 struct l2fwd_crypto_statistics crypto_statistics[RTE_CRYPTO_MAX_DEVS];
262 /* A tsc-based timer responsible for triggering statistics printout */
263 #define TIMER_MILLISECOND 2000000ULL /* around 1ms at 2 Ghz */
264 #define MAX_TIMER_PERIOD 86400UL /* 1 day max */
266 /* default period is 10 seconds */
267 static int64_t timer_period = 10 * TIMER_MILLISECOND * 1000;
269 /* Print out statistics on packets dropped */
273 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
274 uint64_t total_packets_enqueued, total_packets_dequeued,
275 total_packets_errors;
279 total_packets_dropped = 0;
280 total_packets_tx = 0;
281 total_packets_rx = 0;
282 total_packets_enqueued = 0;
283 total_packets_dequeued = 0;
284 total_packets_errors = 0;
286 const char clr[] = { 27, '[', '2', 'J', '\0' };
287 const char topLeft[] = { 27, '[', '1', ';', '1', 'H', '\0' };
289 /* Clear screen and move to top left */
290 printf("%s%s", clr, topLeft);
292 printf("\nPort statistics ====================================");
294 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
295 /* skip disabled ports */
296 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
298 printf("\nStatistics for port %u ------------------------------"
299 "\nPackets sent: %32"PRIu64
300 "\nPackets received: %28"PRIu64
301 "\nPackets dropped: %29"PRIu64,
303 port_statistics[portid].tx,
304 port_statistics[portid].rx,
305 port_statistics[portid].dropped);
307 total_packets_dropped += port_statistics[portid].dropped;
308 total_packets_tx += port_statistics[portid].tx;
309 total_packets_rx += port_statistics[portid].rx;
311 printf("\nCrypto statistics ==================================");
313 for (cdevid = 0; cdevid < RTE_CRYPTO_MAX_DEVS; cdevid++) {
314 /* skip disabled ports */
315 if ((l2fwd_enabled_crypto_mask & (((uint64_t)1) << cdevid)) == 0)
317 printf("\nStatistics for cryptodev %"PRIu64
318 " -------------------------"
319 "\nPackets enqueued: %28"PRIu64
320 "\nPackets dequeued: %28"PRIu64
321 "\nPackets errors: %30"PRIu64,
323 crypto_statistics[cdevid].enqueued,
324 crypto_statistics[cdevid].dequeued,
325 crypto_statistics[cdevid].errors);
327 total_packets_enqueued += crypto_statistics[cdevid].enqueued;
328 total_packets_dequeued += crypto_statistics[cdevid].dequeued;
329 total_packets_errors += crypto_statistics[cdevid].errors;
331 printf("\nAggregate statistics ==============================="
332 "\nTotal packets received: %22"PRIu64
333 "\nTotal packets enqueued: %22"PRIu64
334 "\nTotal packets dequeued: %22"PRIu64
335 "\nTotal packets sent: %26"PRIu64
336 "\nTotal packets dropped: %23"PRIu64
337 "\nTotal packets crypto errors: %17"PRIu64,
339 total_packets_enqueued,
340 total_packets_dequeued,
342 total_packets_dropped,
343 total_packets_errors);
344 printf("\n====================================================\n");
348 l2fwd_crypto_send_burst(struct lcore_queue_conf *qconf, unsigned n,
349 struct l2fwd_crypto_params *cparams)
351 struct rte_crypto_op **op_buffer;
354 op_buffer = (struct rte_crypto_op **)
355 qconf->op_buf[cparams->dev_id].buffer;
357 ret = rte_cryptodev_enqueue_burst(cparams->dev_id,
358 cparams->qp_id, op_buffer, (uint16_t) n);
360 crypto_statistics[cparams->dev_id].enqueued += ret;
361 if (unlikely(ret < n)) {
362 crypto_statistics[cparams->dev_id].errors += (n - ret);
364 rte_pktmbuf_free(op_buffer[ret]->sym->m_src);
365 rte_crypto_op_free(op_buffer[ret]);
373 l2fwd_crypto_enqueue(struct rte_crypto_op *op,
374 struct l2fwd_crypto_params *cparams)
376 unsigned lcore_id, len;
377 struct lcore_queue_conf *qconf;
379 lcore_id = rte_lcore_id();
381 qconf = &lcore_queue_conf[lcore_id];
382 len = qconf->op_buf[cparams->dev_id].len;
383 qconf->op_buf[cparams->dev_id].buffer[len] = op;
386 /* enough ops to be sent */
387 if (len == MAX_PKT_BURST) {
388 l2fwd_crypto_send_burst(qconf, MAX_PKT_BURST, cparams);
392 qconf->op_buf[cparams->dev_id].len = len;
397 l2fwd_simple_crypto_enqueue(struct rte_mbuf *m,
398 struct rte_crypto_op *op,
399 struct l2fwd_crypto_params *cparams)
401 struct ether_hdr *eth_hdr;
402 struct ipv4_hdr *ip_hdr;
404 uint32_t ipdata_offset, data_len;
405 uint32_t pad_len = 0;
408 eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
410 if (eth_hdr->ether_type != rte_cpu_to_be_16(ETHER_TYPE_IPv4))
413 ipdata_offset = sizeof(struct ether_hdr);
415 ip_hdr = (struct ipv4_hdr *)(rte_pktmbuf_mtod(m, char *) +
418 ipdata_offset += (ip_hdr->version_ihl & IPV4_HDR_IHL_MASK)
419 * IPV4_IHL_MULTIPLIER;
422 /* Zero pad data to be crypto'd so it is block aligned */
423 data_len = rte_pktmbuf_data_len(m) - ipdata_offset;
425 if (cparams->do_hash && cparams->hash_verify)
426 data_len -= cparams->digest_length;
428 if (cparams->do_cipher) {
430 * Following algorithms are block cipher algorithms,
431 * and might need padding
433 switch (cparams->cipher_algo) {
434 case RTE_CRYPTO_CIPHER_AES_CBC:
435 case RTE_CRYPTO_CIPHER_AES_ECB:
436 case RTE_CRYPTO_CIPHER_DES_CBC:
437 case RTE_CRYPTO_CIPHER_3DES_CBC:
438 case RTE_CRYPTO_CIPHER_3DES_ECB:
439 if (data_len % cparams->block_size)
440 pad_len = cparams->block_size -
441 (data_len % cparams->block_size);
448 padding = rte_pktmbuf_append(m, pad_len);
449 if (unlikely(!padding))
453 memset(padding, 0, pad_len);
457 /* Set crypto operation data parameters */
458 rte_crypto_op_attach_sym_session(op, cparams->session);
460 if (cparams->do_hash) {
461 if (cparams->auth_iv.length) {
462 uint8_t *iv_ptr = rte_crypto_op_ctod_offset(op,
465 cparams->cipher_iv.length);
467 * Copy IV at the end of the crypto operation,
468 * after the cipher IV, if added
470 rte_memcpy(iv_ptr, cparams->auth_iv.data,
471 cparams->auth_iv.length);
473 if (!cparams->hash_verify) {
474 /* Append space for digest to end of packet */
475 op->sym->auth.digest.data = (uint8_t *)rte_pktmbuf_append(m,
476 cparams->digest_length);
478 op->sym->auth.digest.data = rte_pktmbuf_mtod(m,
479 uint8_t *) + ipdata_offset + data_len;
482 op->sym->auth.digest.phys_addr = rte_pktmbuf_mtophys_offset(m,
483 rte_pktmbuf_pkt_len(m) - cparams->digest_length);
485 /* For wireless algorithms, offset/length must be in bits */
486 if (cparams->auth_algo == RTE_CRYPTO_AUTH_SNOW3G_UIA2 ||
487 cparams->auth_algo == RTE_CRYPTO_AUTH_KASUMI_F9 ||
488 cparams->auth_algo == RTE_CRYPTO_AUTH_ZUC_EIA3) {
489 op->sym->auth.data.offset = ipdata_offset << 3;
490 op->sym->auth.data.length = data_len << 3;
492 op->sym->auth.data.offset = ipdata_offset;
493 op->sym->auth.data.length = data_len;
496 if (cparams->aad.length) {
497 op->sym->auth.aad.data = cparams->aad.data;
498 op->sym->auth.aad.phys_addr = cparams->aad.phys_addr;
500 op->sym->auth.aad.data = NULL;
501 op->sym->auth.aad.phys_addr = 0;
505 if (cparams->do_cipher) {
506 uint8_t *iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
508 /* Copy IV at the end of the crypto operation */
509 rte_memcpy(iv_ptr, cparams->cipher_iv.data,
510 cparams->cipher_iv.length);
512 /* For wireless algorithms, offset/length must be in bits */
513 if (cparams->cipher_algo == RTE_CRYPTO_CIPHER_SNOW3G_UEA2 ||
514 cparams->cipher_algo == RTE_CRYPTO_CIPHER_KASUMI_F8 ||
515 cparams->cipher_algo == RTE_CRYPTO_CIPHER_ZUC_EEA3) {
516 op->sym->cipher.data.offset = ipdata_offset << 3;
517 op->sym->cipher.data.length = data_len << 3;
519 op->sym->cipher.data.offset = ipdata_offset;
520 op->sym->cipher.data.length = data_len;
526 return l2fwd_crypto_enqueue(op, cparams);
530 /* Send the burst of packets on an output interface */
532 l2fwd_send_burst(struct lcore_queue_conf *qconf, unsigned n,
535 struct rte_mbuf **pkt_buffer;
538 pkt_buffer = (struct rte_mbuf **)qconf->pkt_buf[port].buffer;
540 ret = rte_eth_tx_burst(port, 0, pkt_buffer, (uint16_t)n);
541 port_statistics[port].tx += ret;
542 if (unlikely(ret < n)) {
543 port_statistics[port].dropped += (n - ret);
545 rte_pktmbuf_free(pkt_buffer[ret]);
552 /* Enqueue packets for TX and prepare them to be sent */
554 l2fwd_send_packet(struct rte_mbuf *m, uint8_t port)
556 unsigned lcore_id, len;
557 struct lcore_queue_conf *qconf;
559 lcore_id = rte_lcore_id();
561 qconf = &lcore_queue_conf[lcore_id];
562 len = qconf->pkt_buf[port].len;
563 qconf->pkt_buf[port].buffer[len] = m;
566 /* enough pkts to be sent */
567 if (unlikely(len == MAX_PKT_BURST)) {
568 l2fwd_send_burst(qconf, MAX_PKT_BURST, port);
572 qconf->pkt_buf[port].len = len;
577 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
579 struct ether_hdr *eth;
583 dst_port = l2fwd_dst_ports[portid];
584 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
586 /* 02:00:00:00:00:xx */
587 tmp = ð->d_addr.addr_bytes[0];
588 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dst_port << 40);
591 ether_addr_copy(&l2fwd_ports_eth_addr[dst_port], ð->s_addr);
593 l2fwd_send_packet(m, (uint8_t) dst_port);
596 /** Generate random key */
598 generate_random_key(uint8_t *key, unsigned length)
603 fd = open("/dev/urandom", O_RDONLY);
605 rte_exit(EXIT_FAILURE, "Failed to generate random key\n");
607 ret = read(fd, key, length);
610 if (ret != (signed)length)
611 rte_exit(EXIT_FAILURE, "Failed to generate random key\n");
614 static struct rte_cryptodev_sym_session *
615 initialize_crypto_session(struct l2fwd_crypto_options *options,
618 struct rte_crypto_sym_xform *first_xform;
620 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH) {
621 first_xform = &options->cipher_xform;
622 first_xform->next = &options->auth_xform;
623 } else if (options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER) {
624 first_xform = &options->auth_xform;
625 first_xform->next = &options->cipher_xform;
626 } else if (options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
627 first_xform = &options->cipher_xform;
629 first_xform = &options->auth_xform;
632 /* Setup Cipher Parameters */
633 return rte_cryptodev_sym_session_create(cdev_id, first_xform);
637 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options);
639 /* main processing loop */
641 l2fwd_main_loop(struct l2fwd_crypto_options *options)
643 struct rte_mbuf *m, *pkts_burst[MAX_PKT_BURST];
644 struct rte_crypto_op *ops_burst[MAX_PKT_BURST];
646 unsigned lcore_id = rte_lcore_id();
647 uint64_t prev_tsc = 0, diff_tsc, cur_tsc, timer_tsc = 0;
648 unsigned i, j, portid, nb_rx, len;
649 struct lcore_queue_conf *qconf = &lcore_queue_conf[lcore_id];
650 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) /
651 US_PER_S * BURST_TX_DRAIN_US;
652 struct l2fwd_crypto_params *cparams;
653 struct l2fwd_crypto_params port_cparams[qconf->nb_crypto_devs];
655 if (qconf->nb_rx_ports == 0) {
656 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
660 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
662 for (i = 0; i < qconf->nb_rx_ports; i++) {
664 portid = qconf->rx_port_list[i];
665 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
669 for (i = 0; i < qconf->nb_crypto_devs; i++) {
670 port_cparams[i].do_cipher = 0;
671 port_cparams[i].do_hash = 0;
673 switch (options->xform_chain) {
674 case L2FWD_CRYPTO_CIPHER_HASH:
675 case L2FWD_CRYPTO_HASH_CIPHER:
676 port_cparams[i].do_cipher = 1;
677 port_cparams[i].do_hash = 1;
679 case L2FWD_CRYPTO_HASH_ONLY:
680 port_cparams[i].do_hash = 1;
682 case L2FWD_CRYPTO_CIPHER_ONLY:
683 port_cparams[i].do_cipher = 1;
687 port_cparams[i].dev_id = qconf->cryptodev_list[i];
688 port_cparams[i].qp_id = 0;
690 port_cparams[i].block_size = options->block_size;
692 if (port_cparams[i].do_hash) {
693 port_cparams[i].auth_iv.data = options->auth_iv.data;
694 port_cparams[i].auth_iv.length = options->auth_iv.length;
695 if (!options->auth_iv_param)
696 generate_random_key(port_cparams[i].auth_iv.data,
697 port_cparams[i].auth_iv.length);
698 /* Set IV parameters */
699 if (options->auth_iv.length) {
700 options->auth_xform.auth.iv.offset =
701 IV_OFFSET + options->cipher_iv.length;
702 options->auth_xform.auth.iv.length =
703 options->auth_iv.length;
705 port_cparams[i].digest_length =
706 options->auth_xform.auth.digest_length;
707 if (options->auth_xform.auth.add_auth_data_length) {
708 port_cparams[i].aad.data = options->aad.data;
709 port_cparams[i].aad.phys_addr = options->aad.phys_addr;
710 if (!options->aad_param)
711 generate_random_key(port_cparams[i].aad.data,
712 port_cparams[i].aad.length);
715 port_cparams[i].aad.length = 0;
717 if (options->auth_xform.auth.op == RTE_CRYPTO_AUTH_OP_VERIFY)
718 port_cparams[i].hash_verify = 1;
720 port_cparams[i].hash_verify = 0;
722 port_cparams[i].auth_algo = options->auth_xform.auth.algo;
725 if (port_cparams[i].do_cipher) {
726 port_cparams[i].cipher_iv.data = options->cipher_iv.data;
727 port_cparams[i].cipher_iv.length = options->cipher_iv.length;
728 if (!options->cipher_iv_param)
729 generate_random_key(port_cparams[i].cipher_iv.data,
730 port_cparams[i].cipher_iv.length);
732 port_cparams[i].cipher_algo = options->cipher_xform.cipher.algo;
733 /* Set IV parameters */
734 options->cipher_xform.cipher.iv.offset = IV_OFFSET;
735 options->cipher_xform.cipher.iv.length =
736 options->cipher_iv.length;
739 port_cparams[i].session = initialize_crypto_session(options,
740 port_cparams[i].dev_id);
742 if (port_cparams[i].session == NULL)
744 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u cryptoid=%u\n", lcore_id,
745 port_cparams[i].dev_id);
748 l2fwd_crypto_options_print(options);
751 * Initialize previous tsc timestamp before the loop,
752 * to avoid showing the port statistics immediately,
753 * so user can see the crypto information.
755 prev_tsc = rte_rdtsc();
758 cur_tsc = rte_rdtsc();
761 * Crypto device/TX burst queue drain
763 diff_tsc = cur_tsc - prev_tsc;
764 if (unlikely(diff_tsc > drain_tsc)) {
765 /* Enqueue all crypto ops remaining in buffers */
766 for (i = 0; i < qconf->nb_crypto_devs; i++) {
767 cparams = &port_cparams[i];
768 len = qconf->op_buf[cparams->dev_id].len;
769 l2fwd_crypto_send_burst(qconf, len, cparams);
770 qconf->op_buf[cparams->dev_id].len = 0;
772 /* Transmit all packets remaining in buffers */
773 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
774 if (qconf->pkt_buf[portid].len == 0)
776 l2fwd_send_burst(&lcore_queue_conf[lcore_id],
777 qconf->pkt_buf[portid].len,
779 qconf->pkt_buf[portid].len = 0;
782 /* if timer is enabled */
783 if (timer_period > 0) {
785 /* advance the timer */
786 timer_tsc += diff_tsc;
788 /* if timer has reached its timeout */
789 if (unlikely(timer_tsc >=
790 (uint64_t)timer_period)) {
792 /* do this only on master core */
793 if (lcore_id == rte_get_master_lcore()
794 && options->refresh_period) {
805 * Read packet from RX queues
807 for (i = 0; i < qconf->nb_rx_ports; i++) {
808 portid = qconf->rx_port_list[i];
810 cparams = &port_cparams[i];
812 nb_rx = rte_eth_rx_burst((uint8_t) portid, 0,
813 pkts_burst, MAX_PKT_BURST);
815 port_statistics[portid].rx += nb_rx;
819 * If we can't allocate a crypto_ops, then drop
820 * the rest of the burst and dequeue and
821 * process the packets to free offload structs
823 if (rte_crypto_op_bulk_alloc(
824 l2fwd_crypto_op_pool,
825 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
828 for (j = 0; j < nb_rx; j++)
829 rte_pktmbuf_free(pkts_burst[j]);
834 /* Enqueue packets from Crypto device*/
835 for (j = 0; j < nb_rx; j++) {
838 l2fwd_simple_crypto_enqueue(m,
839 ops_burst[j], cparams);
843 /* Dequeue packets from Crypto device */
845 nb_rx = rte_cryptodev_dequeue_burst(
846 cparams->dev_id, cparams->qp_id,
847 ops_burst, MAX_PKT_BURST);
849 crypto_statistics[cparams->dev_id].dequeued +=
852 /* Forward crypto'd packets */
853 for (j = 0; j < nb_rx; j++) {
854 m = ops_burst[j]->sym->m_src;
856 rte_crypto_op_free(ops_burst[j]);
857 l2fwd_simple_forward(m, portid);
859 } while (nb_rx == MAX_PKT_BURST);
865 l2fwd_launch_one_lcore(void *arg)
867 l2fwd_main_loop((struct l2fwd_crypto_options *)arg);
871 /* Display command line arguments usage */
873 l2fwd_crypto_usage(const char *prgname)
875 printf("%s [EAL options] --\n"
876 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
877 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
878 " -s manage all ports from single lcore\n"
879 " -T PERIOD: statistics will be refreshed each PERIOD seconds"
880 " (0 to disable, 10 default, 86400 maximum)\n"
882 " --cdev_type HW / SW / ANY\n"
883 " --chain HASH_CIPHER / CIPHER_HASH / CIPHER_ONLY /"
886 " --cipher_algo ALGO\n"
887 " --cipher_op ENCRYPT / DECRYPT\n"
888 " --cipher_key KEY (bytes separated with \":\")\n"
889 " --cipher_key_random_size SIZE: size of cipher key when generated randomly\n"
890 " --cipher_iv IV (bytes separated with \":\")\n"
891 " --cipher_iv_random_size SIZE: size of cipher IV when generated randomly\n"
893 " --auth_algo ALGO\n"
894 " --auth_op GENERATE / VERIFY\n"
895 " --auth_key KEY (bytes separated with \":\")\n"
896 " --auth_key_random_size SIZE: size of auth key when generated randomly\n"
897 " --auth_iv IV (bytes separated with \":\")\n"
898 " --auth_iv_random_size SIZE: size of auth IV when generated randomly\n"
899 " --aad AAD (bytes separated with \":\")\n"
900 " --aad_random_size SIZE: size of AAD when generated randomly\n"
901 " --digest_size SIZE: size of digest to be generated/verified\n"
904 " --cryptodev_mask MASK: hexadecimal bitmask of crypto devices to configure\n",
908 /** Parse crypto device type command line argument */
910 parse_cryptodev_type(enum cdev_type *type, char *optarg)
912 if (strcmp("HW", optarg) == 0) {
913 *type = CDEV_TYPE_HW;
915 } else if (strcmp("SW", optarg) == 0) {
916 *type = CDEV_TYPE_SW;
918 } else if (strcmp("ANY", optarg) == 0) {
919 *type = CDEV_TYPE_ANY;
926 /** Parse crypto chain xform command line argument */
928 parse_crypto_opt_chain(struct l2fwd_crypto_options *options, char *optarg)
930 if (strcmp("CIPHER_HASH", optarg) == 0) {
931 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
933 } else if (strcmp("HASH_CIPHER", optarg) == 0) {
934 options->xform_chain = L2FWD_CRYPTO_HASH_CIPHER;
936 } else if (strcmp("CIPHER_ONLY", optarg) == 0) {
937 options->xform_chain = L2FWD_CRYPTO_CIPHER_ONLY;
939 } else if (strcmp("HASH_ONLY", optarg) == 0) {
940 options->xform_chain = L2FWD_CRYPTO_HASH_ONLY;
947 /** Parse crypto cipher algo option command line argument */
949 parse_cipher_algo(enum rte_crypto_cipher_algorithm *algo, char *optarg)
952 if (rte_cryptodev_get_cipher_algo_enum(algo, optarg) < 0) {
953 RTE_LOG(ERR, USER1, "Cipher algorithm specified "
961 /** Parse crypto cipher operation command line argument */
963 parse_cipher_op(enum rte_crypto_cipher_operation *op, char *optarg)
965 if (strcmp("ENCRYPT", optarg) == 0) {
966 *op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
968 } else if (strcmp("DECRYPT", optarg) == 0) {
969 *op = RTE_CRYPTO_CIPHER_OP_DECRYPT;
973 printf("Cipher operation not supported!\n");
977 /** Parse crypto key command line argument */
979 parse_key(uint8_t *data, char *input_arg)
984 for (byte_count = 0, token = strtok(input_arg, ":");
985 (byte_count < MAX_KEY_SIZE) && (token != NULL);
986 token = strtok(NULL, ":")) {
988 int number = (int)strtol(token, NULL, 16);
990 if (errno == EINVAL || errno == ERANGE || number > 0xFF)
993 data[byte_count++] = (uint8_t)number;
999 /** Parse size param*/
1001 parse_size(int *size, const char *q_arg)
1006 /* parse hexadecimal string */
1007 n = strtoul(q_arg, &end, 10);
1008 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1012 printf("invalid size\n");
1020 /** Parse crypto cipher operation command line argument */
1022 parse_auth_algo(enum rte_crypto_auth_algorithm *algo, char *optarg)
1024 if (rte_cryptodev_get_auth_algo_enum(algo, optarg) < 0) {
1025 RTE_LOG(ERR, USER1, "Authentication algorithm specified "
1026 "not supported!\n");
1034 parse_auth_op(enum rte_crypto_auth_operation *op, char *optarg)
1036 if (strcmp("VERIFY", optarg) == 0) {
1037 *op = RTE_CRYPTO_AUTH_OP_VERIFY;
1039 } else if (strcmp("GENERATE", optarg) == 0) {
1040 *op = RTE_CRYPTO_AUTH_OP_GENERATE;
1044 printf("Authentication operation specified not supported!\n");
1049 parse_cryptodev_mask(struct l2fwd_crypto_options *options,
1055 /* parse hexadecimal string */
1056 pm = strtoul(q_arg, &end, 16);
1057 if ((pm == '\0') || (end == NULL) || (*end != '\0'))
1060 options->cryptodev_mask = pm;
1061 if (options->cryptodev_mask == 0) {
1062 printf("invalid cryptodev_mask specified\n");
1069 /** Parse long options */
1071 l2fwd_crypto_parse_args_long_options(struct l2fwd_crypto_options *options,
1072 struct option *lgopts, int option_index)
1076 if (strcmp(lgopts[option_index].name, "cdev_type") == 0) {
1077 retval = parse_cryptodev_type(&options->type, optarg);
1079 snprintf(options->string_type, MAX_STR_LEN,
1084 else if (strcmp(lgopts[option_index].name, "chain") == 0)
1085 return parse_crypto_opt_chain(options, optarg);
1087 /* Cipher options */
1088 else if (strcmp(lgopts[option_index].name, "cipher_algo") == 0)
1089 return parse_cipher_algo(&options->cipher_xform.cipher.algo,
1092 else if (strcmp(lgopts[option_index].name, "cipher_op") == 0)
1093 return parse_cipher_op(&options->cipher_xform.cipher.op,
1096 else if (strcmp(lgopts[option_index].name, "cipher_key") == 0) {
1097 options->ckey_param = 1;
1098 options->cipher_xform.cipher.key.length =
1099 parse_key(options->cipher_xform.cipher.key.data, optarg);
1100 if (options->cipher_xform.cipher.key.length > 0)
1106 else if (strcmp(lgopts[option_index].name, "cipher_key_random_size") == 0)
1107 return parse_size(&options->ckey_random_size, optarg);
1109 else if (strcmp(lgopts[option_index].name, "cipher_iv") == 0) {
1110 options->cipher_iv_param = 1;
1111 options->cipher_iv.length =
1112 parse_key(options->cipher_iv.data, optarg);
1113 if (options->cipher_iv.length > 0)
1119 else if (strcmp(lgopts[option_index].name, "cipher_iv_random_size") == 0)
1120 return parse_size(&options->cipher_iv_random_size, optarg);
1122 /* Authentication options */
1123 else if (strcmp(lgopts[option_index].name, "auth_algo") == 0) {
1124 return parse_auth_algo(&options->auth_xform.auth.algo,
1128 else if (strcmp(lgopts[option_index].name, "auth_op") == 0)
1129 return parse_auth_op(&options->auth_xform.auth.op,
1132 else if (strcmp(lgopts[option_index].name, "auth_key") == 0) {
1133 options->akey_param = 1;
1134 options->auth_xform.auth.key.length =
1135 parse_key(options->auth_xform.auth.key.data, optarg);
1136 if (options->auth_xform.auth.key.length > 0)
1142 else if (strcmp(lgopts[option_index].name, "auth_key_random_size") == 0) {
1143 return parse_size(&options->akey_random_size, optarg);
1147 else if (strcmp(lgopts[option_index].name, "auth_iv") == 0) {
1148 options->auth_iv_param = 1;
1149 options->auth_iv.length =
1150 parse_key(options->auth_iv.data, optarg);
1151 if (options->auth_iv.length > 0)
1157 else if (strcmp(lgopts[option_index].name, "auth_iv_random_size") == 0)
1158 return parse_size(&options->auth_iv_random_size, optarg);
1160 else if (strcmp(lgopts[option_index].name, "aad") == 0) {
1161 options->aad_param = 1;
1162 options->aad.length =
1163 parse_key(options->aad.data, optarg);
1164 if (options->aad.length > 0)
1170 else if (strcmp(lgopts[option_index].name, "aad_random_size") == 0) {
1171 return parse_size(&options->aad_random_size, optarg);
1174 else if (strcmp(lgopts[option_index].name, "digest_size") == 0) {
1175 return parse_size(&options->digest_size, optarg);
1178 else if (strcmp(lgopts[option_index].name, "sessionless") == 0) {
1179 options->sessionless = 1;
1183 else if (strcmp(lgopts[option_index].name, "cryptodev_mask") == 0)
1184 return parse_cryptodev_mask(options, optarg);
1189 /** Parse port mask */
1191 l2fwd_crypto_parse_portmask(struct l2fwd_crypto_options *options,
1197 /* parse hexadecimal string */
1198 pm = strtoul(q_arg, &end, 16);
1199 if ((pm == '\0') || (end == NULL) || (*end != '\0'))
1202 options->portmask = pm;
1203 if (options->portmask == 0) {
1204 printf("invalid portmask specified\n");
1211 /** Parse number of queues */
1213 l2fwd_crypto_parse_nqueue(struct l2fwd_crypto_options *options,
1219 /* parse hexadecimal string */
1220 n = strtoul(q_arg, &end, 10);
1221 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1223 else if (n >= MAX_RX_QUEUE_PER_LCORE)
1226 options->nb_ports_per_lcore = n;
1227 if (options->nb_ports_per_lcore == 0) {
1228 printf("invalid number of ports selected\n");
1235 /** Parse timer period */
1237 l2fwd_crypto_parse_timer_period(struct l2fwd_crypto_options *options,
1243 /* parse number string */
1244 n = (unsigned)strtol(q_arg, &end, 10);
1245 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1248 if (n >= MAX_TIMER_PERIOD) {
1249 printf("Warning refresh period specified %lu is greater than "
1250 "max value %lu! using max value",
1251 n, MAX_TIMER_PERIOD);
1252 n = MAX_TIMER_PERIOD;
1255 options->refresh_period = n * 1000 * TIMER_MILLISECOND;
1260 /** Generate default options for application */
1262 l2fwd_crypto_default_options(struct l2fwd_crypto_options *options)
1264 options->portmask = 0xffffffff;
1265 options->nb_ports_per_lcore = 1;
1266 options->refresh_period = 10000;
1267 options->single_lcore = 0;
1268 options->sessionless = 0;
1270 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
1273 options->cipher_xform.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
1274 options->cipher_xform.next = NULL;
1275 options->ckey_param = 0;
1276 options->ckey_random_size = -1;
1277 options->cipher_xform.cipher.key.length = 0;
1278 options->cipher_iv_param = 0;
1279 options->cipher_iv_random_size = -1;
1280 options->cipher_iv.length = 0;
1282 options->cipher_xform.cipher.algo = RTE_CRYPTO_CIPHER_AES_CBC;
1283 options->cipher_xform.cipher.op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
1285 /* Authentication Data */
1286 options->auth_xform.type = RTE_CRYPTO_SYM_XFORM_AUTH;
1287 options->auth_xform.next = NULL;
1288 options->akey_param = 0;
1289 options->akey_random_size = -1;
1290 options->auth_xform.auth.key.length = 0;
1291 options->auth_iv_param = 0;
1292 options->auth_iv_random_size = -1;
1293 options->auth_iv.length = 0;
1294 options->aad_param = 0;
1295 options->aad_random_size = -1;
1296 options->aad.length = 0;
1297 options->digest_size = -1;
1299 options->auth_xform.auth.algo = RTE_CRYPTO_AUTH_SHA1_HMAC;
1300 options->auth_xform.auth.op = RTE_CRYPTO_AUTH_OP_GENERATE;
1302 options->type = CDEV_TYPE_ANY;
1303 options->cryptodev_mask = UINT64_MAX;
1307 display_cipher_info(struct l2fwd_crypto_options *options)
1309 printf("\n---- Cipher information ---\n");
1310 printf("Algorithm: %s\n",
1311 rte_crypto_cipher_algorithm_strings[options->cipher_xform.cipher.algo]);
1312 rte_hexdump(stdout, "Cipher key:",
1313 options->cipher_xform.cipher.key.data,
1314 options->cipher_xform.cipher.key.length);
1315 rte_hexdump(stdout, "IV:", options->cipher_iv.data, options->cipher_iv.length);
1319 display_auth_info(struct l2fwd_crypto_options *options)
1321 printf("\n---- Authentication information ---\n");
1322 printf("Algorithm: %s\n",
1323 rte_crypto_auth_algorithm_strings[options->auth_xform.auth.algo]);
1324 rte_hexdump(stdout, "Auth key:",
1325 options->auth_xform.auth.key.data,
1326 options->auth_xform.auth.key.length);
1327 rte_hexdump(stdout, "IV:", options->auth_iv.data, options->auth_iv.length);
1328 rte_hexdump(stdout, "AAD:", options->aad.data, options->aad.length);
1332 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options)
1334 char string_cipher_op[MAX_STR_LEN];
1335 char string_auth_op[MAX_STR_LEN];
1337 if (options->cipher_xform.cipher.op == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
1338 strcpy(string_cipher_op, "Encrypt");
1340 strcpy(string_cipher_op, "Decrypt");
1342 if (options->auth_xform.auth.op == RTE_CRYPTO_AUTH_OP_GENERATE)
1343 strcpy(string_auth_op, "Auth generate");
1345 strcpy(string_auth_op, "Auth verify");
1347 printf("Options:-\nn");
1348 printf("portmask: %x\n", options->portmask);
1349 printf("ports per lcore: %u\n", options->nb_ports_per_lcore);
1350 printf("refresh period : %u\n", options->refresh_period);
1351 printf("single lcore mode: %s\n",
1352 options->single_lcore ? "enabled" : "disabled");
1353 printf("stats_printing: %s\n",
1354 options->refresh_period == 0 ? "disabled" : "enabled");
1356 printf("sessionless crypto: %s\n",
1357 options->sessionless ? "enabled" : "disabled");
1359 if (options->ckey_param && (options->ckey_random_size != -1))
1360 printf("Cipher key already parsed, ignoring size of random key\n");
1362 if (options->akey_param && (options->akey_random_size != -1))
1363 printf("Auth key already parsed, ignoring size of random key\n");
1365 if (options->cipher_iv_param && (options->cipher_iv_random_size != -1))
1366 printf("Cipher IV already parsed, ignoring size of random IV\n");
1368 if (options->auth_iv_param && (options->auth_iv_random_size != -1))
1369 printf("Auth IV already parsed, ignoring size of random IV\n");
1371 if (options->aad_param && (options->aad_random_size != -1))
1372 printf("AAD already parsed, ignoring size of random AAD\n");
1374 printf("\nCrypto chain: ");
1375 switch (options->xform_chain) {
1376 case L2FWD_CRYPTO_CIPHER_HASH:
1377 printf("Input --> %s --> %s --> Output\n",
1378 string_cipher_op, string_auth_op);
1379 display_cipher_info(options);
1380 display_auth_info(options);
1382 case L2FWD_CRYPTO_HASH_CIPHER:
1383 printf("Input --> %s --> %s --> Output\n",
1384 string_auth_op, string_cipher_op);
1385 display_cipher_info(options);
1386 display_auth_info(options);
1388 case L2FWD_CRYPTO_HASH_ONLY:
1389 printf("Input --> %s --> Output\n", string_auth_op);
1390 display_auth_info(options);
1392 case L2FWD_CRYPTO_CIPHER_ONLY:
1393 printf("Input --> %s --> Output\n", string_cipher_op);
1394 display_cipher_info(options);
1399 /* Parse the argument given in the command line of the application */
1401 l2fwd_crypto_parse_args(struct l2fwd_crypto_options *options,
1402 int argc, char **argv)
1404 int opt, retval, option_index;
1405 char **argvopt = argv, *prgname = argv[0];
1407 static struct option lgopts[] = {
1408 { "sessionless", no_argument, 0, 0 },
1410 { "cdev_type", required_argument, 0, 0 },
1411 { "chain", required_argument, 0, 0 },
1413 { "cipher_algo", required_argument, 0, 0 },
1414 { "cipher_op", required_argument, 0, 0 },
1415 { "cipher_key", required_argument, 0, 0 },
1416 { "cipher_key_random_size", required_argument, 0, 0 },
1417 { "cipher_iv", required_argument, 0, 0 },
1418 { "cipher_iv_random_size", required_argument, 0, 0 },
1420 { "auth_algo", required_argument, 0, 0 },
1421 { "auth_op", required_argument, 0, 0 },
1422 { "auth_key", required_argument, 0, 0 },
1423 { "auth_key_random_size", required_argument, 0, 0 },
1424 { "auth_iv", required_argument, 0, 0 },
1425 { "auth_iv_random_size", required_argument, 0, 0 },
1427 { "aad", required_argument, 0, 0 },
1428 { "aad_random_size", required_argument, 0, 0 },
1429 { "digest_size", required_argument, 0, 0 },
1431 { "sessionless", no_argument, 0, 0 },
1432 { "cryptodev_mask", required_argument, 0, 0},
1437 l2fwd_crypto_default_options(options);
1439 while ((opt = getopt_long(argc, argvopt, "p:q:sT:", lgopts,
1440 &option_index)) != EOF) {
1444 retval = l2fwd_crypto_parse_args_long_options(options,
1445 lgopts, option_index);
1447 l2fwd_crypto_usage(prgname);
1454 retval = l2fwd_crypto_parse_portmask(options, optarg);
1456 l2fwd_crypto_usage(prgname);
1463 retval = l2fwd_crypto_parse_nqueue(options, optarg);
1465 l2fwd_crypto_usage(prgname);
1472 options->single_lcore = 1;
1478 retval = l2fwd_crypto_parse_timer_period(options,
1481 l2fwd_crypto_usage(prgname);
1487 l2fwd_crypto_usage(prgname);
1494 argv[optind-1] = prgname;
1497 optind = 1; /* reset getopt lib */
1502 /* Check the link status of all ports in up to 9s, and print them finally */
1504 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
1506 #define CHECK_INTERVAL 100 /* 100ms */
1507 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
1508 uint8_t portid, count, all_ports_up, print_flag = 0;
1509 struct rte_eth_link link;
1511 printf("\nChecking link status");
1513 for (count = 0; count <= MAX_CHECK_TIME; count++) {
1515 for (portid = 0; portid < port_num; portid++) {
1516 if ((port_mask & (1 << portid)) == 0)
1518 memset(&link, 0, sizeof(link));
1519 rte_eth_link_get_nowait(portid, &link);
1520 /* print link status if flag set */
1521 if (print_flag == 1) {
1522 if (link.link_status)
1523 printf("Port %d Link Up - speed %u "
1524 "Mbps - %s\n", (uint8_t)portid,
1525 (unsigned)link.link_speed,
1526 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
1527 ("full-duplex") : ("half-duplex\n"));
1529 printf("Port %d Link Down\n",
1533 /* clear all_ports_up flag if any link down */
1534 if (link.link_status == ETH_LINK_DOWN) {
1539 /* after finally printing all link status, get out */
1540 if (print_flag == 1)
1543 if (all_ports_up == 0) {
1546 rte_delay_ms(CHECK_INTERVAL);
1549 /* set the print_flag if all ports up or timeout */
1550 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
1557 /* Check if device has to be HW/SW or any */
1559 check_type(struct l2fwd_crypto_options *options, struct rte_cryptodev_info *dev_info)
1561 if (options->type == CDEV_TYPE_HW &&
1562 (dev_info->feature_flags & RTE_CRYPTODEV_FF_HW_ACCELERATED))
1564 if (options->type == CDEV_TYPE_SW &&
1565 !(dev_info->feature_flags & RTE_CRYPTODEV_FF_HW_ACCELERATED))
1567 if (options->type == CDEV_TYPE_ANY)
1573 /* Check if the device is enabled by cryptodev_mask */
1575 check_cryptodev_mask(struct l2fwd_crypto_options *options,
1578 if (options->cryptodev_mask & (1 << cdev_id))
1585 check_supported_size(uint16_t length, uint16_t min, uint16_t max,
1591 if (increment == 0) {
1598 /* Range of values */
1599 for (supp_size = min; supp_size <= max; supp_size += increment) {
1600 if (length == supp_size)
1608 check_iv_param(const struct rte_crypto_param_range *iv_range_size,
1609 unsigned int iv_param, int iv_random_size,
1610 uint16_t *iv_length)
1613 * Check if length of provided IV is supported
1614 * by the algorithm chosen.
1617 if (check_supported_size(*iv_length,
1620 iv_range_size->increment)
1622 printf("Unsupported IV length\n");
1626 * Check if length of IV to be randomly generated
1627 * is supported by the algorithm chosen.
1629 } else if (iv_random_size != -1) {
1630 if (check_supported_size(iv_random_size,
1633 iv_range_size->increment)
1635 printf("Unsupported IV length\n");
1638 *iv_length = iv_random_size;
1639 /* No size provided, use minimum size. */
1641 *iv_length = iv_range_size->min;
1647 initialize_cryptodevs(struct l2fwd_crypto_options *options, unsigned nb_ports,
1648 uint8_t *enabled_cdevs)
1650 unsigned i, cdev_id, cdev_count, enabled_cdev_count = 0;
1651 const struct rte_cryptodev_capabilities *cap;
1652 enum rte_crypto_auth_algorithm cap_auth_algo;
1653 enum rte_crypto_auth_algorithm opt_auth_algo;
1654 enum rte_crypto_cipher_algorithm cap_cipher_algo;
1655 enum rte_crypto_cipher_algorithm opt_cipher_algo;
1658 cdev_count = rte_cryptodev_count();
1659 if (cdev_count == 0) {
1660 printf("No crypto devices available\n");
1664 for (cdev_id = 0; cdev_id < cdev_count && enabled_cdev_count < nb_ports;
1666 struct rte_cryptodev_qp_conf qp_conf;
1667 struct rte_cryptodev_info dev_info;
1669 struct rte_cryptodev_config conf = {
1670 .nb_queue_pairs = 1,
1671 .socket_id = SOCKET_ID_ANY,
1678 if (check_cryptodev_mask(options, (uint8_t)cdev_id))
1681 rte_cryptodev_info_get(cdev_id, &dev_info);
1683 /* Set cipher parameters */
1684 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH ||
1685 options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER ||
1686 options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
1687 /* Check if device supports cipher algo */
1689 opt_cipher_algo = options->cipher_xform.cipher.algo;
1690 cap = &dev_info.capabilities[i];
1691 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1692 cap_cipher_algo = cap->sym.cipher.algo;
1693 if (cap->sym.xform_type ==
1694 RTE_CRYPTO_SYM_XFORM_CIPHER) {
1695 if (cap_cipher_algo == opt_cipher_algo) {
1696 if (check_type(options, &dev_info) == 0)
1700 cap = &dev_info.capabilities[++i];
1703 if (cap->op == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1704 printf("Algorithm %s not supported by cryptodev %u"
1705 " or device not of preferred type (%s)\n",
1706 rte_crypto_cipher_algorithm_strings[opt_cipher_algo],
1708 options->string_type);
1712 options->block_size = cap->sym.cipher.block_size;
1714 check_iv_param(&cap->sym.cipher.iv_size,
1715 options->cipher_iv_param,
1716 options->cipher_iv_random_size,
1717 &options->cipher_iv.length);
1720 * Check if length of provided cipher key is supported
1721 * by the algorithm chosen.
1723 if (options->ckey_param) {
1724 if (check_supported_size(
1725 options->cipher_xform.cipher.key.length,
1726 cap->sym.cipher.key_size.min,
1727 cap->sym.cipher.key_size.max,
1728 cap->sym.cipher.key_size.increment)
1730 printf("Unsupported cipher key length\n");
1734 * Check if length of the cipher key to be randomly generated
1735 * is supported by the algorithm chosen.
1737 } else if (options->ckey_random_size != -1) {
1738 if (check_supported_size(options->ckey_random_size,
1739 cap->sym.cipher.key_size.min,
1740 cap->sym.cipher.key_size.max,
1741 cap->sym.cipher.key_size.increment)
1743 printf("Unsupported cipher key length\n");
1746 options->cipher_xform.cipher.key.length =
1747 options->ckey_random_size;
1748 /* No size provided, use minimum size. */
1750 options->cipher_xform.cipher.key.length =
1751 cap->sym.cipher.key_size.min;
1753 if (!options->ckey_param)
1754 generate_random_key(
1755 options->cipher_xform.cipher.key.data,
1756 options->cipher_xform.cipher.key.length);
1760 /* Set auth parameters */
1761 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH ||
1762 options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER ||
1763 options->xform_chain == L2FWD_CRYPTO_HASH_ONLY) {
1764 /* Check if device supports auth algo */
1766 opt_auth_algo = options->auth_xform.auth.algo;
1767 cap = &dev_info.capabilities[i];
1768 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1769 cap_auth_algo = cap->sym.auth.algo;
1770 if ((cap->sym.xform_type == RTE_CRYPTO_SYM_XFORM_AUTH) &&
1771 (cap_auth_algo == opt_auth_algo) &&
1772 (check_type(options, &dev_info) == 0)) {
1775 cap = &dev_info.capabilities[++i];
1778 if (cap->op == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1779 printf("Algorithm %s not supported by cryptodev %u"
1780 " or device not of preferred type (%s)\n",
1781 rte_crypto_auth_algorithm_strings[opt_auth_algo],
1783 options->string_type);
1787 check_iv_param(&cap->sym.auth.iv_size,
1788 options->auth_iv_param,
1789 options->auth_iv_random_size,
1790 &options->auth_iv.length);
1792 * Check if length of provided AAD is supported
1793 * by the algorithm chosen.
1795 if (options->aad_param) {
1796 if (check_supported_size(options->aad.length,
1797 cap->sym.auth.aad_size.min,
1798 cap->sym.auth.aad_size.max,
1799 cap->sym.auth.aad_size.increment)
1801 printf("Unsupported AAD length\n");
1805 * Check if length of AAD to be randomly generated
1806 * is supported by the algorithm chosen.
1808 } else if (options->aad_random_size != -1) {
1809 if (check_supported_size(options->aad_random_size,
1810 cap->sym.auth.aad_size.min,
1811 cap->sym.auth.aad_size.max,
1812 cap->sym.auth.aad_size.increment)
1814 printf("Unsupported AAD length\n");
1817 options->aad.length = options->aad_random_size;
1818 /* No size provided, use minimum size. */
1820 options->aad.length = cap->sym.auth.aad_size.min;
1822 options->auth_xform.auth.add_auth_data_length =
1823 options->aad.length;
1826 * Check if length of provided auth key is supported
1827 * by the algorithm chosen.
1829 if (options->akey_param) {
1830 if (check_supported_size(
1831 options->auth_xform.auth.key.length,
1832 cap->sym.auth.key_size.min,
1833 cap->sym.auth.key_size.max,
1834 cap->sym.auth.key_size.increment)
1836 printf("Unsupported auth key length\n");
1840 * Check if length of the auth key to be randomly generated
1841 * is supported by the algorithm chosen.
1843 } else if (options->akey_random_size != -1) {
1844 if (check_supported_size(options->akey_random_size,
1845 cap->sym.auth.key_size.min,
1846 cap->sym.auth.key_size.max,
1847 cap->sym.auth.key_size.increment)
1849 printf("Unsupported auth key length\n");
1852 options->auth_xform.auth.key.length =
1853 options->akey_random_size;
1854 /* No size provided, use minimum size. */
1856 options->auth_xform.auth.key.length =
1857 cap->sym.auth.key_size.min;
1859 if (!options->akey_param)
1860 generate_random_key(
1861 options->auth_xform.auth.key.data,
1862 options->auth_xform.auth.key.length);
1864 /* Check if digest size is supported by the algorithm. */
1865 if (options->digest_size != -1) {
1866 if (check_supported_size(options->digest_size,
1867 cap->sym.auth.digest_size.min,
1868 cap->sym.auth.digest_size.max,
1869 cap->sym.auth.digest_size.increment)
1871 printf("Unsupported digest length\n");
1874 options->auth_xform.auth.digest_length =
1875 options->digest_size;
1876 /* No size provided, use minimum size. */
1878 options->auth_xform.auth.digest_length =
1879 cap->sym.auth.digest_size.min;
1882 retval = rte_cryptodev_configure(cdev_id, &conf);
1884 printf("Failed to configure cryptodev %u", cdev_id);
1888 qp_conf.nb_descriptors = 2048;
1890 retval = rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf,
1893 printf("Failed to setup queue pair %u on cryptodev %u",
1898 retval = rte_cryptodev_start(cdev_id);
1900 printf("Failed to start device %u: error %d\n",
1905 l2fwd_enabled_crypto_mask |= (((uint64_t)1) << cdev_id);
1907 enabled_cdevs[cdev_id] = 1;
1908 enabled_cdev_count++;
1911 return enabled_cdev_count;
1915 initialize_ports(struct l2fwd_crypto_options *options)
1917 uint8_t last_portid, portid;
1918 unsigned enabled_portcount = 0;
1919 unsigned nb_ports = rte_eth_dev_count();
1921 if (nb_ports == 0) {
1922 printf("No Ethernet ports - bye\n");
1926 /* Reset l2fwd_dst_ports */
1927 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
1928 l2fwd_dst_ports[portid] = 0;
1930 for (last_portid = 0, portid = 0; portid < nb_ports; portid++) {
1933 /* Skip ports that are not enabled */
1934 if ((options->portmask & (1 << portid)) == 0)
1938 printf("Initializing port %u... ", (unsigned) portid);
1940 retval = rte_eth_dev_configure(portid, 1, 1, &port_conf);
1942 printf("Cannot configure device: err=%d, port=%u\n",
1943 retval, (unsigned) portid);
1947 /* init one RX queue */
1949 retval = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
1950 rte_eth_dev_socket_id(portid),
1951 NULL, l2fwd_pktmbuf_pool);
1953 printf("rte_eth_rx_queue_setup:err=%d, port=%u\n",
1954 retval, (unsigned) portid);
1958 /* init one TX queue on each port */
1960 retval = rte_eth_tx_queue_setup(portid, 0, nb_txd,
1961 rte_eth_dev_socket_id(portid),
1964 printf("rte_eth_tx_queue_setup:err=%d, port=%u\n",
1965 retval, (unsigned) portid);
1971 retval = rte_eth_dev_start(portid);
1973 printf("rte_eth_dev_start:err=%d, port=%u\n",
1974 retval, (unsigned) portid);
1978 rte_eth_promiscuous_enable(portid);
1980 rte_eth_macaddr_get(portid, &l2fwd_ports_eth_addr[portid]);
1982 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
1984 l2fwd_ports_eth_addr[portid].addr_bytes[0],
1985 l2fwd_ports_eth_addr[portid].addr_bytes[1],
1986 l2fwd_ports_eth_addr[portid].addr_bytes[2],
1987 l2fwd_ports_eth_addr[portid].addr_bytes[3],
1988 l2fwd_ports_eth_addr[portid].addr_bytes[4],
1989 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
1991 /* initialize port stats */
1992 memset(&port_statistics, 0, sizeof(port_statistics));
1994 /* Setup port forwarding table */
1995 if (enabled_portcount % 2) {
1996 l2fwd_dst_ports[portid] = last_portid;
1997 l2fwd_dst_ports[last_portid] = portid;
1999 last_portid = portid;
2002 l2fwd_enabled_port_mask |= (1 << portid);
2003 enabled_portcount++;
2006 if (enabled_portcount == 1) {
2007 l2fwd_dst_ports[last_portid] = last_portid;
2008 } else if (enabled_portcount % 2) {
2009 printf("odd number of ports in portmask- bye\n");
2013 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
2015 return enabled_portcount;
2019 reserve_key_memory(struct l2fwd_crypto_options *options)
2021 options->cipher_xform.cipher.key.data = rte_malloc("crypto key",
2023 if (options->cipher_xform.cipher.key.data == NULL)
2024 rte_exit(EXIT_FAILURE, "Failed to allocate memory for cipher key");
2027 options->auth_xform.auth.key.data = rte_malloc("auth key",
2029 if (options->auth_xform.auth.key.data == NULL)
2030 rte_exit(EXIT_FAILURE, "Failed to allocate memory for auth key");
2032 options->cipher_iv.data = rte_malloc("cipher iv", MAX_KEY_SIZE, 0);
2033 if (options->cipher_iv.data == NULL)
2034 rte_exit(EXIT_FAILURE, "Failed to allocate memory for cipher IV");
2036 options->auth_iv.data = rte_malloc("auth iv", MAX_KEY_SIZE, 0);
2037 if (options->auth_iv.data == NULL)
2038 rte_exit(EXIT_FAILURE, "Failed to allocate memory for auth IV");
2040 options->aad.data = rte_malloc("aad", MAX_KEY_SIZE, 0);
2041 if (options->aad.data == NULL)
2042 rte_exit(EXIT_FAILURE, "Failed to allocate memory for AAD");
2043 options->aad.phys_addr = rte_malloc_virt2phy(options->aad.data);
2047 main(int argc, char **argv)
2049 struct lcore_queue_conf *qconf;
2050 struct l2fwd_crypto_options options;
2052 uint8_t nb_ports, nb_cryptodevs, portid, cdev_id;
2053 unsigned lcore_id, rx_lcore_id;
2054 int ret, enabled_cdevcount, enabled_portcount;
2055 uint8_t enabled_cdevs[RTE_CRYPTO_MAX_DEVS] = {0};
2058 ret = rte_eal_init(argc, argv);
2060 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
2064 /* reserve memory for Cipher/Auth key and IV */
2065 reserve_key_memory(&options);
2067 /* parse application arguments (after the EAL ones) */
2068 ret = l2fwd_crypto_parse_args(&options, argc, argv);
2070 rte_exit(EXIT_FAILURE, "Invalid L2FWD-CRYPTO arguments\n");
2072 /* create the mbuf pool */
2073 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF, 512,
2074 sizeof(struct rte_crypto_op),
2075 RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
2076 if (l2fwd_pktmbuf_pool == NULL)
2077 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
2079 /* create crypto op pool */
2080 l2fwd_crypto_op_pool = rte_crypto_op_pool_create("crypto_op_pool",
2081 RTE_CRYPTO_OP_TYPE_SYMMETRIC, NB_MBUF, 128, MAXIMUM_IV_LENGTH,
2083 if (l2fwd_crypto_op_pool == NULL)
2084 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
2086 /* Enable Ethernet ports */
2087 enabled_portcount = initialize_ports(&options);
2088 if (enabled_portcount < 1)
2089 rte_exit(EXIT_FAILURE, "Failed to initial Ethernet ports\n");
2091 nb_ports = rte_eth_dev_count();
2092 /* Initialize the port/queue configuration of each logical core */
2093 for (rx_lcore_id = 0, qconf = NULL, portid = 0;
2094 portid < nb_ports; portid++) {
2096 /* skip ports that are not enabled */
2097 if ((options.portmask & (1 << portid)) == 0)
2100 if (options.single_lcore && qconf == NULL) {
2101 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
2103 if (rx_lcore_id >= RTE_MAX_LCORE)
2104 rte_exit(EXIT_FAILURE,
2105 "Not enough cores\n");
2107 } else if (!options.single_lcore) {
2108 /* get the lcore_id for this port */
2109 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
2110 lcore_queue_conf[rx_lcore_id].nb_rx_ports ==
2111 options.nb_ports_per_lcore) {
2113 if (rx_lcore_id >= RTE_MAX_LCORE)
2114 rte_exit(EXIT_FAILURE,
2115 "Not enough cores\n");
2119 /* Assigned a new logical core in the loop above. */
2120 if (qconf != &lcore_queue_conf[rx_lcore_id])
2121 qconf = &lcore_queue_conf[rx_lcore_id];
2123 qconf->rx_port_list[qconf->nb_rx_ports] = portid;
2124 qconf->nb_rx_ports++;
2126 printf("Lcore %u: RX port %u\n", rx_lcore_id, (unsigned)portid);
2129 /* Enable Crypto devices */
2130 enabled_cdevcount = initialize_cryptodevs(&options, enabled_portcount,
2132 if (enabled_cdevcount < 0)
2133 rte_exit(EXIT_FAILURE, "Failed to initialize crypto devices\n");
2135 if (enabled_cdevcount < enabled_portcount)
2136 rte_exit(EXIT_FAILURE, "Number of capable crypto devices (%d) "
2137 "has to be more or equal to number of ports (%d)\n",
2138 enabled_cdevcount, enabled_portcount);
2140 nb_cryptodevs = rte_cryptodev_count();
2142 /* Initialize the port/cryptodev configuration of each logical core */
2143 for (rx_lcore_id = 0, qconf = NULL, cdev_id = 0;
2144 cdev_id < nb_cryptodevs && enabled_cdevcount;
2146 /* Crypto op not supported by crypto device */
2147 if (!enabled_cdevs[cdev_id])
2150 if (options.single_lcore && qconf == NULL) {
2151 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
2153 if (rx_lcore_id >= RTE_MAX_LCORE)
2154 rte_exit(EXIT_FAILURE,
2155 "Not enough cores\n");
2157 } else if (!options.single_lcore) {
2158 /* get the lcore_id for this port */
2159 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
2160 lcore_queue_conf[rx_lcore_id].nb_crypto_devs ==
2161 options.nb_ports_per_lcore) {
2163 if (rx_lcore_id >= RTE_MAX_LCORE)
2164 rte_exit(EXIT_FAILURE,
2165 "Not enough cores\n");
2169 /* Assigned a new logical core in the loop above. */
2170 if (qconf != &lcore_queue_conf[rx_lcore_id])
2171 qconf = &lcore_queue_conf[rx_lcore_id];
2173 qconf->cryptodev_list[qconf->nb_crypto_devs] = cdev_id;
2174 qconf->nb_crypto_devs++;
2176 enabled_cdevcount--;
2178 printf("Lcore %u: cryptodev %u\n", rx_lcore_id,
2182 /* launch per-lcore init on every lcore */
2183 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, (void *)&options,
2185 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
2186 if (rte_eal_wait_lcore(lcore_id) < 0)