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);
484 op->sym->auth.digest.length = cparams->digest_length;
486 /* For wireless algorithms, offset/length must be in bits */
487 if (cparams->auth_algo == RTE_CRYPTO_AUTH_SNOW3G_UIA2 ||
488 cparams->auth_algo == RTE_CRYPTO_AUTH_KASUMI_F9 ||
489 cparams->auth_algo == RTE_CRYPTO_AUTH_ZUC_EIA3) {
490 op->sym->auth.data.offset = ipdata_offset << 3;
491 op->sym->auth.data.length = data_len << 3;
493 op->sym->auth.data.offset = ipdata_offset;
494 op->sym->auth.data.length = data_len;
497 if (cparams->aad.length) {
498 op->sym->auth.aad.data = cparams->aad.data;
499 op->sym->auth.aad.phys_addr = cparams->aad.phys_addr;
500 op->sym->auth.aad.length = cparams->aad.length;
502 op->sym->auth.aad.data = NULL;
503 op->sym->auth.aad.phys_addr = 0;
504 op->sym->auth.aad.length = 0;
508 if (cparams->do_cipher) {
509 uint8_t *iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
511 /* Copy IV at the end of the crypto operation */
512 rte_memcpy(iv_ptr, cparams->cipher_iv.data,
513 cparams->cipher_iv.length);
515 /* For wireless algorithms, offset/length must be in bits */
516 if (cparams->cipher_algo == RTE_CRYPTO_CIPHER_SNOW3G_UEA2 ||
517 cparams->cipher_algo == RTE_CRYPTO_CIPHER_KASUMI_F8 ||
518 cparams->cipher_algo == RTE_CRYPTO_CIPHER_ZUC_EEA3) {
519 op->sym->cipher.data.offset = ipdata_offset << 3;
520 op->sym->cipher.data.length = data_len << 3;
522 op->sym->cipher.data.offset = ipdata_offset;
523 op->sym->cipher.data.length = data_len;
529 return l2fwd_crypto_enqueue(op, cparams);
533 /* Send the burst of packets on an output interface */
535 l2fwd_send_burst(struct lcore_queue_conf *qconf, unsigned n,
538 struct rte_mbuf **pkt_buffer;
541 pkt_buffer = (struct rte_mbuf **)qconf->pkt_buf[port].buffer;
543 ret = rte_eth_tx_burst(port, 0, pkt_buffer, (uint16_t)n);
544 port_statistics[port].tx += ret;
545 if (unlikely(ret < n)) {
546 port_statistics[port].dropped += (n - ret);
548 rte_pktmbuf_free(pkt_buffer[ret]);
555 /* Enqueue packets for TX and prepare them to be sent */
557 l2fwd_send_packet(struct rte_mbuf *m, uint8_t port)
559 unsigned lcore_id, len;
560 struct lcore_queue_conf *qconf;
562 lcore_id = rte_lcore_id();
564 qconf = &lcore_queue_conf[lcore_id];
565 len = qconf->pkt_buf[port].len;
566 qconf->pkt_buf[port].buffer[len] = m;
569 /* enough pkts to be sent */
570 if (unlikely(len == MAX_PKT_BURST)) {
571 l2fwd_send_burst(qconf, MAX_PKT_BURST, port);
575 qconf->pkt_buf[port].len = len;
580 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
582 struct ether_hdr *eth;
586 dst_port = l2fwd_dst_ports[portid];
587 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
589 /* 02:00:00:00:00:xx */
590 tmp = ð->d_addr.addr_bytes[0];
591 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dst_port << 40);
594 ether_addr_copy(&l2fwd_ports_eth_addr[dst_port], ð->s_addr);
596 l2fwd_send_packet(m, (uint8_t) dst_port);
599 /** Generate random key */
601 generate_random_key(uint8_t *key, unsigned length)
606 fd = open("/dev/urandom", O_RDONLY);
608 rte_exit(EXIT_FAILURE, "Failed to generate random key\n");
610 ret = read(fd, key, length);
613 if (ret != (signed)length)
614 rte_exit(EXIT_FAILURE, "Failed to generate random key\n");
617 static struct rte_cryptodev_sym_session *
618 initialize_crypto_session(struct l2fwd_crypto_options *options,
621 struct rte_crypto_sym_xform *first_xform;
623 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH) {
624 first_xform = &options->cipher_xform;
625 first_xform->next = &options->auth_xform;
626 } else if (options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER) {
627 first_xform = &options->auth_xform;
628 first_xform->next = &options->cipher_xform;
629 } else if (options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
630 first_xform = &options->cipher_xform;
632 first_xform = &options->auth_xform;
635 /* Setup Cipher Parameters */
636 return rte_cryptodev_sym_session_create(cdev_id, first_xform);
640 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options);
642 /* main processing loop */
644 l2fwd_main_loop(struct l2fwd_crypto_options *options)
646 struct rte_mbuf *m, *pkts_burst[MAX_PKT_BURST];
647 struct rte_crypto_op *ops_burst[MAX_PKT_BURST];
649 unsigned lcore_id = rte_lcore_id();
650 uint64_t prev_tsc = 0, diff_tsc, cur_tsc, timer_tsc = 0;
651 unsigned i, j, portid, nb_rx, len;
652 struct lcore_queue_conf *qconf = &lcore_queue_conf[lcore_id];
653 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) /
654 US_PER_S * BURST_TX_DRAIN_US;
655 struct l2fwd_crypto_params *cparams;
656 struct l2fwd_crypto_params port_cparams[qconf->nb_crypto_devs];
658 if (qconf->nb_rx_ports == 0) {
659 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
663 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
665 for (i = 0; i < qconf->nb_rx_ports; i++) {
667 portid = qconf->rx_port_list[i];
668 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
672 for (i = 0; i < qconf->nb_crypto_devs; i++) {
673 port_cparams[i].do_cipher = 0;
674 port_cparams[i].do_hash = 0;
676 switch (options->xform_chain) {
677 case L2FWD_CRYPTO_CIPHER_HASH:
678 case L2FWD_CRYPTO_HASH_CIPHER:
679 port_cparams[i].do_cipher = 1;
680 port_cparams[i].do_hash = 1;
682 case L2FWD_CRYPTO_HASH_ONLY:
683 port_cparams[i].do_hash = 1;
685 case L2FWD_CRYPTO_CIPHER_ONLY:
686 port_cparams[i].do_cipher = 1;
690 port_cparams[i].dev_id = qconf->cryptodev_list[i];
691 port_cparams[i].qp_id = 0;
693 port_cparams[i].block_size = options->block_size;
695 if (port_cparams[i].do_hash) {
696 port_cparams[i].auth_iv.data = options->auth_iv.data;
697 port_cparams[i].auth_iv.length = options->auth_iv.length;
698 if (!options->auth_iv_param)
699 generate_random_key(port_cparams[i].auth_iv.data,
700 port_cparams[i].auth_iv.length);
701 /* Set IV parameters */
702 if (options->auth_iv.length) {
703 options->auth_xform.auth.iv.offset =
704 IV_OFFSET + options->cipher_iv.length;
705 options->auth_xform.auth.iv.length =
706 options->auth_iv.length;
708 port_cparams[i].digest_length =
709 options->auth_xform.auth.digest_length;
710 if (options->auth_xform.auth.add_auth_data_length) {
711 port_cparams[i].aad.data = options->aad.data;
712 port_cparams[i].aad.length =
713 options->auth_xform.auth.add_auth_data_length;
714 port_cparams[i].aad.phys_addr = options->aad.phys_addr;
715 if (!options->aad_param)
716 generate_random_key(port_cparams[i].aad.data,
717 port_cparams[i].aad.length);
720 port_cparams[i].aad.length = 0;
722 if (options->auth_xform.auth.op == RTE_CRYPTO_AUTH_OP_VERIFY)
723 port_cparams[i].hash_verify = 1;
725 port_cparams[i].hash_verify = 0;
727 port_cparams[i].auth_algo = options->auth_xform.auth.algo;
730 if (port_cparams[i].do_cipher) {
731 port_cparams[i].cipher_iv.data = options->cipher_iv.data;
732 port_cparams[i].cipher_iv.length = options->cipher_iv.length;
733 if (!options->cipher_iv_param)
734 generate_random_key(port_cparams[i].cipher_iv.data,
735 port_cparams[i].cipher_iv.length);
737 port_cparams[i].cipher_algo = options->cipher_xform.cipher.algo;
738 /* Set IV parameters */
739 options->cipher_xform.cipher.iv.offset = IV_OFFSET;
740 options->cipher_xform.cipher.iv.length =
741 options->cipher_iv.length;
744 port_cparams[i].session = initialize_crypto_session(options,
745 port_cparams[i].dev_id);
747 if (port_cparams[i].session == NULL)
749 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u cryptoid=%u\n", lcore_id,
750 port_cparams[i].dev_id);
753 l2fwd_crypto_options_print(options);
756 * Initialize previous tsc timestamp before the loop,
757 * to avoid showing the port statistics immediately,
758 * so user can see the crypto information.
760 prev_tsc = rte_rdtsc();
763 cur_tsc = rte_rdtsc();
766 * Crypto device/TX burst queue drain
768 diff_tsc = cur_tsc - prev_tsc;
769 if (unlikely(diff_tsc > drain_tsc)) {
770 /* Enqueue all crypto ops remaining in buffers */
771 for (i = 0; i < qconf->nb_crypto_devs; i++) {
772 cparams = &port_cparams[i];
773 len = qconf->op_buf[cparams->dev_id].len;
774 l2fwd_crypto_send_burst(qconf, len, cparams);
775 qconf->op_buf[cparams->dev_id].len = 0;
777 /* Transmit all packets remaining in buffers */
778 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
779 if (qconf->pkt_buf[portid].len == 0)
781 l2fwd_send_burst(&lcore_queue_conf[lcore_id],
782 qconf->pkt_buf[portid].len,
784 qconf->pkt_buf[portid].len = 0;
787 /* if timer is enabled */
788 if (timer_period > 0) {
790 /* advance the timer */
791 timer_tsc += diff_tsc;
793 /* if timer has reached its timeout */
794 if (unlikely(timer_tsc >=
795 (uint64_t)timer_period)) {
797 /* do this only on master core */
798 if (lcore_id == rte_get_master_lcore()
799 && options->refresh_period) {
810 * Read packet from RX queues
812 for (i = 0; i < qconf->nb_rx_ports; i++) {
813 portid = qconf->rx_port_list[i];
815 cparams = &port_cparams[i];
817 nb_rx = rte_eth_rx_burst((uint8_t) portid, 0,
818 pkts_burst, MAX_PKT_BURST);
820 port_statistics[portid].rx += nb_rx;
824 * If we can't allocate a crypto_ops, then drop
825 * the rest of the burst and dequeue and
826 * process the packets to free offload structs
828 if (rte_crypto_op_bulk_alloc(
829 l2fwd_crypto_op_pool,
830 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
833 for (j = 0; j < nb_rx; j++)
834 rte_pktmbuf_free(pkts_burst[j]);
839 /* Enqueue packets from Crypto device*/
840 for (j = 0; j < nb_rx; j++) {
843 l2fwd_simple_crypto_enqueue(m,
844 ops_burst[j], cparams);
848 /* Dequeue packets from Crypto device */
850 nb_rx = rte_cryptodev_dequeue_burst(
851 cparams->dev_id, cparams->qp_id,
852 ops_burst, MAX_PKT_BURST);
854 crypto_statistics[cparams->dev_id].dequeued +=
857 /* Forward crypto'd packets */
858 for (j = 0; j < nb_rx; j++) {
859 m = ops_burst[j]->sym->m_src;
861 rte_crypto_op_free(ops_burst[j]);
862 l2fwd_simple_forward(m, portid);
864 } while (nb_rx == MAX_PKT_BURST);
870 l2fwd_launch_one_lcore(void *arg)
872 l2fwd_main_loop((struct l2fwd_crypto_options *)arg);
876 /* Display command line arguments usage */
878 l2fwd_crypto_usage(const char *prgname)
880 printf("%s [EAL options] --\n"
881 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
882 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
883 " -s manage all ports from single lcore\n"
884 " -T PERIOD: statistics will be refreshed each PERIOD seconds"
885 " (0 to disable, 10 default, 86400 maximum)\n"
887 " --cdev_type HW / SW / ANY\n"
888 " --chain HASH_CIPHER / CIPHER_HASH / CIPHER_ONLY /"
891 " --cipher_algo ALGO\n"
892 " --cipher_op ENCRYPT / DECRYPT\n"
893 " --cipher_key KEY (bytes separated with \":\")\n"
894 " --cipher_key_random_size SIZE: size of cipher key when generated randomly\n"
895 " --cipher_iv IV (bytes separated with \":\")\n"
896 " --cipher_iv_random_size SIZE: size of cipher IV when generated randomly\n"
898 " --auth_algo ALGO\n"
899 " --auth_op GENERATE / VERIFY\n"
900 " --auth_key KEY (bytes separated with \":\")\n"
901 " --auth_key_random_size SIZE: size of auth key when generated randomly\n"
902 " --auth_iv IV (bytes separated with \":\")\n"
903 " --auth_iv_random_size SIZE: size of auth IV when generated randomly\n"
904 " --aad AAD (bytes separated with \":\")\n"
905 " --aad_random_size SIZE: size of AAD when generated randomly\n"
906 " --digest_size SIZE: size of digest to be generated/verified\n"
909 " --cryptodev_mask MASK: hexadecimal bitmask of crypto devices to configure\n",
913 /** Parse crypto device type command line argument */
915 parse_cryptodev_type(enum cdev_type *type, char *optarg)
917 if (strcmp("HW", optarg) == 0) {
918 *type = CDEV_TYPE_HW;
920 } else if (strcmp("SW", optarg) == 0) {
921 *type = CDEV_TYPE_SW;
923 } else if (strcmp("ANY", optarg) == 0) {
924 *type = CDEV_TYPE_ANY;
931 /** Parse crypto chain xform command line argument */
933 parse_crypto_opt_chain(struct l2fwd_crypto_options *options, char *optarg)
935 if (strcmp("CIPHER_HASH", optarg) == 0) {
936 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
938 } else if (strcmp("HASH_CIPHER", optarg) == 0) {
939 options->xform_chain = L2FWD_CRYPTO_HASH_CIPHER;
941 } else if (strcmp("CIPHER_ONLY", optarg) == 0) {
942 options->xform_chain = L2FWD_CRYPTO_CIPHER_ONLY;
944 } else if (strcmp("HASH_ONLY", optarg) == 0) {
945 options->xform_chain = L2FWD_CRYPTO_HASH_ONLY;
952 /** Parse crypto cipher algo option command line argument */
954 parse_cipher_algo(enum rte_crypto_cipher_algorithm *algo, char *optarg)
957 if (rte_cryptodev_get_cipher_algo_enum(algo, optarg) < 0) {
958 RTE_LOG(ERR, USER1, "Cipher algorithm specified "
966 /** Parse crypto cipher operation command line argument */
968 parse_cipher_op(enum rte_crypto_cipher_operation *op, char *optarg)
970 if (strcmp("ENCRYPT", optarg) == 0) {
971 *op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
973 } else if (strcmp("DECRYPT", optarg) == 0) {
974 *op = RTE_CRYPTO_CIPHER_OP_DECRYPT;
978 printf("Cipher operation not supported!\n");
982 /** Parse crypto key command line argument */
984 parse_key(uint8_t *data, char *input_arg)
989 for (byte_count = 0, token = strtok(input_arg, ":");
990 (byte_count < MAX_KEY_SIZE) && (token != NULL);
991 token = strtok(NULL, ":")) {
993 int number = (int)strtol(token, NULL, 16);
995 if (errno == EINVAL || errno == ERANGE || number > 0xFF)
998 data[byte_count++] = (uint8_t)number;
1004 /** Parse size param*/
1006 parse_size(int *size, const char *q_arg)
1011 /* parse hexadecimal string */
1012 n = strtoul(q_arg, &end, 10);
1013 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1017 printf("invalid size\n");
1025 /** Parse crypto cipher operation command line argument */
1027 parse_auth_algo(enum rte_crypto_auth_algorithm *algo, char *optarg)
1029 if (rte_cryptodev_get_auth_algo_enum(algo, optarg) < 0) {
1030 RTE_LOG(ERR, USER1, "Authentication algorithm specified "
1031 "not supported!\n");
1039 parse_auth_op(enum rte_crypto_auth_operation *op, char *optarg)
1041 if (strcmp("VERIFY", optarg) == 0) {
1042 *op = RTE_CRYPTO_AUTH_OP_VERIFY;
1044 } else if (strcmp("GENERATE", optarg) == 0) {
1045 *op = RTE_CRYPTO_AUTH_OP_GENERATE;
1049 printf("Authentication operation specified not supported!\n");
1054 parse_cryptodev_mask(struct l2fwd_crypto_options *options,
1060 /* parse hexadecimal string */
1061 pm = strtoul(q_arg, &end, 16);
1062 if ((pm == '\0') || (end == NULL) || (*end != '\0'))
1065 options->cryptodev_mask = pm;
1066 if (options->cryptodev_mask == 0) {
1067 printf("invalid cryptodev_mask specified\n");
1074 /** Parse long options */
1076 l2fwd_crypto_parse_args_long_options(struct l2fwd_crypto_options *options,
1077 struct option *lgopts, int option_index)
1081 if (strcmp(lgopts[option_index].name, "cdev_type") == 0) {
1082 retval = parse_cryptodev_type(&options->type, optarg);
1084 snprintf(options->string_type, MAX_STR_LEN,
1089 else if (strcmp(lgopts[option_index].name, "chain") == 0)
1090 return parse_crypto_opt_chain(options, optarg);
1092 /* Cipher options */
1093 else if (strcmp(lgopts[option_index].name, "cipher_algo") == 0)
1094 return parse_cipher_algo(&options->cipher_xform.cipher.algo,
1097 else if (strcmp(lgopts[option_index].name, "cipher_op") == 0)
1098 return parse_cipher_op(&options->cipher_xform.cipher.op,
1101 else if (strcmp(lgopts[option_index].name, "cipher_key") == 0) {
1102 options->ckey_param = 1;
1103 options->cipher_xform.cipher.key.length =
1104 parse_key(options->cipher_xform.cipher.key.data, optarg);
1105 if (options->cipher_xform.cipher.key.length > 0)
1111 else if (strcmp(lgopts[option_index].name, "cipher_key_random_size") == 0)
1112 return parse_size(&options->ckey_random_size, optarg);
1114 else if (strcmp(lgopts[option_index].name, "cipher_iv") == 0) {
1115 options->cipher_iv_param = 1;
1116 options->cipher_iv.length =
1117 parse_key(options->cipher_iv.data, optarg);
1118 if (options->cipher_iv.length > 0)
1124 else if (strcmp(lgopts[option_index].name, "cipher_iv_random_size") == 0)
1125 return parse_size(&options->cipher_iv_random_size, optarg);
1127 /* Authentication options */
1128 else if (strcmp(lgopts[option_index].name, "auth_algo") == 0) {
1129 return parse_auth_algo(&options->auth_xform.auth.algo,
1133 else if (strcmp(lgopts[option_index].name, "auth_op") == 0)
1134 return parse_auth_op(&options->auth_xform.auth.op,
1137 else if (strcmp(lgopts[option_index].name, "auth_key") == 0) {
1138 options->akey_param = 1;
1139 options->auth_xform.auth.key.length =
1140 parse_key(options->auth_xform.auth.key.data, optarg);
1141 if (options->auth_xform.auth.key.length > 0)
1147 else if (strcmp(lgopts[option_index].name, "auth_key_random_size") == 0) {
1148 return parse_size(&options->akey_random_size, optarg);
1152 else if (strcmp(lgopts[option_index].name, "auth_iv") == 0) {
1153 options->auth_iv_param = 1;
1154 options->auth_iv.length =
1155 parse_key(options->auth_iv.data, optarg);
1156 if (options->auth_iv.length > 0)
1162 else if (strcmp(lgopts[option_index].name, "auth_iv_random_size") == 0)
1163 return parse_size(&options->auth_iv_random_size, optarg);
1165 else if (strcmp(lgopts[option_index].name, "aad") == 0) {
1166 options->aad_param = 1;
1167 options->aad.length =
1168 parse_key(options->aad.data, optarg);
1169 if (options->aad.length > 0)
1175 else if (strcmp(lgopts[option_index].name, "aad_random_size") == 0) {
1176 return parse_size(&options->aad_random_size, optarg);
1179 else if (strcmp(lgopts[option_index].name, "digest_size") == 0) {
1180 return parse_size(&options->digest_size, optarg);
1183 else if (strcmp(lgopts[option_index].name, "sessionless") == 0) {
1184 options->sessionless = 1;
1188 else if (strcmp(lgopts[option_index].name, "cryptodev_mask") == 0)
1189 return parse_cryptodev_mask(options, optarg);
1194 /** Parse port mask */
1196 l2fwd_crypto_parse_portmask(struct l2fwd_crypto_options *options,
1202 /* parse hexadecimal string */
1203 pm = strtoul(q_arg, &end, 16);
1204 if ((pm == '\0') || (end == NULL) || (*end != '\0'))
1207 options->portmask = pm;
1208 if (options->portmask == 0) {
1209 printf("invalid portmask specified\n");
1216 /** Parse number of queues */
1218 l2fwd_crypto_parse_nqueue(struct l2fwd_crypto_options *options,
1224 /* parse hexadecimal string */
1225 n = strtoul(q_arg, &end, 10);
1226 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1228 else if (n >= MAX_RX_QUEUE_PER_LCORE)
1231 options->nb_ports_per_lcore = n;
1232 if (options->nb_ports_per_lcore == 0) {
1233 printf("invalid number of ports selected\n");
1240 /** Parse timer period */
1242 l2fwd_crypto_parse_timer_period(struct l2fwd_crypto_options *options,
1248 /* parse number string */
1249 n = (unsigned)strtol(q_arg, &end, 10);
1250 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1253 if (n >= MAX_TIMER_PERIOD) {
1254 printf("Warning refresh period specified %lu is greater than "
1255 "max value %lu! using max value",
1256 n, MAX_TIMER_PERIOD);
1257 n = MAX_TIMER_PERIOD;
1260 options->refresh_period = n * 1000 * TIMER_MILLISECOND;
1265 /** Generate default options for application */
1267 l2fwd_crypto_default_options(struct l2fwd_crypto_options *options)
1269 options->portmask = 0xffffffff;
1270 options->nb_ports_per_lcore = 1;
1271 options->refresh_period = 10000;
1272 options->single_lcore = 0;
1273 options->sessionless = 0;
1275 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
1278 options->cipher_xform.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
1279 options->cipher_xform.next = NULL;
1280 options->ckey_param = 0;
1281 options->ckey_random_size = -1;
1282 options->cipher_xform.cipher.key.length = 0;
1283 options->cipher_iv_param = 0;
1284 options->cipher_iv_random_size = -1;
1285 options->cipher_iv.length = 0;
1287 options->cipher_xform.cipher.algo = RTE_CRYPTO_CIPHER_AES_CBC;
1288 options->cipher_xform.cipher.op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
1290 /* Authentication Data */
1291 options->auth_xform.type = RTE_CRYPTO_SYM_XFORM_AUTH;
1292 options->auth_xform.next = NULL;
1293 options->akey_param = 0;
1294 options->akey_random_size = -1;
1295 options->auth_xform.auth.key.length = 0;
1296 options->auth_iv_param = 0;
1297 options->auth_iv_random_size = -1;
1298 options->auth_iv.length = 0;
1299 options->aad_param = 0;
1300 options->aad_random_size = -1;
1301 options->aad.length = 0;
1302 options->digest_size = -1;
1304 options->auth_xform.auth.algo = RTE_CRYPTO_AUTH_SHA1_HMAC;
1305 options->auth_xform.auth.op = RTE_CRYPTO_AUTH_OP_GENERATE;
1307 options->type = CDEV_TYPE_ANY;
1308 options->cryptodev_mask = UINT64_MAX;
1312 display_cipher_info(struct l2fwd_crypto_options *options)
1314 printf("\n---- Cipher information ---\n");
1315 printf("Algorithm: %s\n",
1316 rte_crypto_cipher_algorithm_strings[options->cipher_xform.cipher.algo]);
1317 rte_hexdump(stdout, "Cipher key:",
1318 options->cipher_xform.cipher.key.data,
1319 options->cipher_xform.cipher.key.length);
1320 rte_hexdump(stdout, "IV:", options->cipher_iv.data, options->cipher_iv.length);
1324 display_auth_info(struct l2fwd_crypto_options *options)
1326 printf("\n---- Authentication information ---\n");
1327 printf("Algorithm: %s\n",
1328 rte_crypto_auth_algorithm_strings[options->auth_xform.auth.algo]);
1329 rte_hexdump(stdout, "Auth key:",
1330 options->auth_xform.auth.key.data,
1331 options->auth_xform.auth.key.length);
1332 rte_hexdump(stdout, "IV:", options->auth_iv.data, options->auth_iv.length);
1333 rte_hexdump(stdout, "AAD:", options->aad.data, options->aad.length);
1337 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options)
1339 char string_cipher_op[MAX_STR_LEN];
1340 char string_auth_op[MAX_STR_LEN];
1342 if (options->cipher_xform.cipher.op == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
1343 strcpy(string_cipher_op, "Encrypt");
1345 strcpy(string_cipher_op, "Decrypt");
1347 if (options->auth_xform.auth.op == RTE_CRYPTO_AUTH_OP_GENERATE)
1348 strcpy(string_auth_op, "Auth generate");
1350 strcpy(string_auth_op, "Auth verify");
1352 printf("Options:-\nn");
1353 printf("portmask: %x\n", options->portmask);
1354 printf("ports per lcore: %u\n", options->nb_ports_per_lcore);
1355 printf("refresh period : %u\n", options->refresh_period);
1356 printf("single lcore mode: %s\n",
1357 options->single_lcore ? "enabled" : "disabled");
1358 printf("stats_printing: %s\n",
1359 options->refresh_period == 0 ? "disabled" : "enabled");
1361 printf("sessionless crypto: %s\n",
1362 options->sessionless ? "enabled" : "disabled");
1364 if (options->ckey_param && (options->ckey_random_size != -1))
1365 printf("Cipher key already parsed, ignoring size of random key\n");
1367 if (options->akey_param && (options->akey_random_size != -1))
1368 printf("Auth key already parsed, ignoring size of random key\n");
1370 if (options->cipher_iv_param && (options->cipher_iv_random_size != -1))
1371 printf("Cipher IV already parsed, ignoring size of random IV\n");
1373 if (options->auth_iv_param && (options->auth_iv_random_size != -1))
1374 printf("Auth IV already parsed, ignoring size of random IV\n");
1376 if (options->aad_param && (options->aad_random_size != -1))
1377 printf("AAD already parsed, ignoring size of random AAD\n");
1379 printf("\nCrypto chain: ");
1380 switch (options->xform_chain) {
1381 case L2FWD_CRYPTO_CIPHER_HASH:
1382 printf("Input --> %s --> %s --> Output\n",
1383 string_cipher_op, string_auth_op);
1384 display_cipher_info(options);
1385 display_auth_info(options);
1387 case L2FWD_CRYPTO_HASH_CIPHER:
1388 printf("Input --> %s --> %s --> Output\n",
1389 string_auth_op, string_cipher_op);
1390 display_cipher_info(options);
1391 display_auth_info(options);
1393 case L2FWD_CRYPTO_HASH_ONLY:
1394 printf("Input --> %s --> Output\n", string_auth_op);
1395 display_auth_info(options);
1397 case L2FWD_CRYPTO_CIPHER_ONLY:
1398 printf("Input --> %s --> Output\n", string_cipher_op);
1399 display_cipher_info(options);
1404 /* Parse the argument given in the command line of the application */
1406 l2fwd_crypto_parse_args(struct l2fwd_crypto_options *options,
1407 int argc, char **argv)
1409 int opt, retval, option_index;
1410 char **argvopt = argv, *prgname = argv[0];
1412 static struct option lgopts[] = {
1413 { "sessionless", no_argument, 0, 0 },
1415 { "cdev_type", required_argument, 0, 0 },
1416 { "chain", required_argument, 0, 0 },
1418 { "cipher_algo", required_argument, 0, 0 },
1419 { "cipher_op", required_argument, 0, 0 },
1420 { "cipher_key", required_argument, 0, 0 },
1421 { "cipher_key_random_size", required_argument, 0, 0 },
1422 { "cipher_iv", required_argument, 0, 0 },
1423 { "cipher_iv_random_size", required_argument, 0, 0 },
1425 { "auth_algo", required_argument, 0, 0 },
1426 { "auth_op", required_argument, 0, 0 },
1427 { "auth_key", required_argument, 0, 0 },
1428 { "auth_key_random_size", required_argument, 0, 0 },
1429 { "auth_iv", required_argument, 0, 0 },
1430 { "auth_iv_random_size", required_argument, 0, 0 },
1432 { "aad", required_argument, 0, 0 },
1433 { "aad_random_size", required_argument, 0, 0 },
1434 { "digest_size", required_argument, 0, 0 },
1436 { "sessionless", no_argument, 0, 0 },
1437 { "cryptodev_mask", required_argument, 0, 0},
1442 l2fwd_crypto_default_options(options);
1444 while ((opt = getopt_long(argc, argvopt, "p:q:sT:", lgopts,
1445 &option_index)) != EOF) {
1449 retval = l2fwd_crypto_parse_args_long_options(options,
1450 lgopts, option_index);
1452 l2fwd_crypto_usage(prgname);
1459 retval = l2fwd_crypto_parse_portmask(options, optarg);
1461 l2fwd_crypto_usage(prgname);
1468 retval = l2fwd_crypto_parse_nqueue(options, optarg);
1470 l2fwd_crypto_usage(prgname);
1477 options->single_lcore = 1;
1483 retval = l2fwd_crypto_parse_timer_period(options,
1486 l2fwd_crypto_usage(prgname);
1492 l2fwd_crypto_usage(prgname);
1499 argv[optind-1] = prgname;
1502 optind = 1; /* reset getopt lib */
1507 /* Check the link status of all ports in up to 9s, and print them finally */
1509 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
1511 #define CHECK_INTERVAL 100 /* 100ms */
1512 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
1513 uint8_t portid, count, all_ports_up, print_flag = 0;
1514 struct rte_eth_link link;
1516 printf("\nChecking link status");
1518 for (count = 0; count <= MAX_CHECK_TIME; count++) {
1520 for (portid = 0; portid < port_num; portid++) {
1521 if ((port_mask & (1 << portid)) == 0)
1523 memset(&link, 0, sizeof(link));
1524 rte_eth_link_get_nowait(portid, &link);
1525 /* print link status if flag set */
1526 if (print_flag == 1) {
1527 if (link.link_status)
1528 printf("Port %d Link Up - speed %u "
1529 "Mbps - %s\n", (uint8_t)portid,
1530 (unsigned)link.link_speed,
1531 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
1532 ("full-duplex") : ("half-duplex\n"));
1534 printf("Port %d Link Down\n",
1538 /* clear all_ports_up flag if any link down */
1539 if (link.link_status == ETH_LINK_DOWN) {
1544 /* after finally printing all link status, get out */
1545 if (print_flag == 1)
1548 if (all_ports_up == 0) {
1551 rte_delay_ms(CHECK_INTERVAL);
1554 /* set the print_flag if all ports up or timeout */
1555 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
1562 /* Check if device has to be HW/SW or any */
1564 check_type(struct l2fwd_crypto_options *options, struct rte_cryptodev_info *dev_info)
1566 if (options->type == CDEV_TYPE_HW &&
1567 (dev_info->feature_flags & RTE_CRYPTODEV_FF_HW_ACCELERATED))
1569 if (options->type == CDEV_TYPE_SW &&
1570 !(dev_info->feature_flags & RTE_CRYPTODEV_FF_HW_ACCELERATED))
1572 if (options->type == CDEV_TYPE_ANY)
1578 /* Check if the device is enabled by cryptodev_mask */
1580 check_cryptodev_mask(struct l2fwd_crypto_options *options,
1583 if (options->cryptodev_mask & (1 << cdev_id))
1590 check_supported_size(uint16_t length, uint16_t min, uint16_t max,
1596 if (increment == 0) {
1603 /* Range of values */
1604 for (supp_size = min; supp_size <= max; supp_size += increment) {
1605 if (length == supp_size)
1613 check_iv_param(const struct rte_crypto_param_range *iv_range_size,
1614 unsigned int iv_param, int iv_random_size,
1615 uint16_t *iv_length)
1618 * Check if length of provided IV is supported
1619 * by the algorithm chosen.
1622 if (check_supported_size(*iv_length,
1625 iv_range_size->increment)
1627 printf("Unsupported IV length\n");
1631 * Check if length of IV to be randomly generated
1632 * is supported by the algorithm chosen.
1634 } else if (iv_random_size != -1) {
1635 if (check_supported_size(iv_random_size,
1638 iv_range_size->increment)
1640 printf("Unsupported IV length\n");
1643 *iv_length = iv_random_size;
1644 /* No size provided, use minimum size. */
1646 *iv_length = iv_range_size->min;
1652 initialize_cryptodevs(struct l2fwd_crypto_options *options, unsigned nb_ports,
1653 uint8_t *enabled_cdevs)
1655 unsigned i, cdev_id, cdev_count, enabled_cdev_count = 0;
1656 const struct rte_cryptodev_capabilities *cap;
1657 enum rte_crypto_auth_algorithm cap_auth_algo;
1658 enum rte_crypto_auth_algorithm opt_auth_algo;
1659 enum rte_crypto_cipher_algorithm cap_cipher_algo;
1660 enum rte_crypto_cipher_algorithm opt_cipher_algo;
1663 cdev_count = rte_cryptodev_count();
1664 if (cdev_count == 0) {
1665 printf("No crypto devices available\n");
1669 for (cdev_id = 0; cdev_id < cdev_count && enabled_cdev_count < nb_ports;
1671 struct rte_cryptodev_qp_conf qp_conf;
1672 struct rte_cryptodev_info dev_info;
1674 struct rte_cryptodev_config conf = {
1675 .nb_queue_pairs = 1,
1676 .socket_id = SOCKET_ID_ANY,
1683 if (check_cryptodev_mask(options, (uint8_t)cdev_id))
1686 rte_cryptodev_info_get(cdev_id, &dev_info);
1688 /* Set cipher parameters */
1689 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH ||
1690 options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER ||
1691 options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
1692 /* Check if device supports cipher algo */
1694 opt_cipher_algo = options->cipher_xform.cipher.algo;
1695 cap = &dev_info.capabilities[i];
1696 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1697 cap_cipher_algo = cap->sym.cipher.algo;
1698 if (cap->sym.xform_type ==
1699 RTE_CRYPTO_SYM_XFORM_CIPHER) {
1700 if (cap_cipher_algo == opt_cipher_algo) {
1701 if (check_type(options, &dev_info) == 0)
1705 cap = &dev_info.capabilities[++i];
1708 if (cap->op == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1709 printf("Algorithm %s not supported by cryptodev %u"
1710 " or device not of preferred type (%s)\n",
1711 rte_crypto_cipher_algorithm_strings[opt_cipher_algo],
1713 options->string_type);
1717 options->block_size = cap->sym.cipher.block_size;
1719 check_iv_param(&cap->sym.cipher.iv_size,
1720 options->cipher_iv_param,
1721 options->cipher_iv_random_size,
1722 &options->cipher_iv.length);
1725 * Check if length of provided cipher key is supported
1726 * by the algorithm chosen.
1728 if (options->ckey_param) {
1729 if (check_supported_size(
1730 options->cipher_xform.cipher.key.length,
1731 cap->sym.cipher.key_size.min,
1732 cap->sym.cipher.key_size.max,
1733 cap->sym.cipher.key_size.increment)
1735 printf("Unsupported cipher key length\n");
1739 * Check if length of the cipher key to be randomly generated
1740 * is supported by the algorithm chosen.
1742 } else if (options->ckey_random_size != -1) {
1743 if (check_supported_size(options->ckey_random_size,
1744 cap->sym.cipher.key_size.min,
1745 cap->sym.cipher.key_size.max,
1746 cap->sym.cipher.key_size.increment)
1748 printf("Unsupported cipher key length\n");
1751 options->cipher_xform.cipher.key.length =
1752 options->ckey_random_size;
1753 /* No size provided, use minimum size. */
1755 options->cipher_xform.cipher.key.length =
1756 cap->sym.cipher.key_size.min;
1758 if (!options->ckey_param)
1759 generate_random_key(
1760 options->cipher_xform.cipher.key.data,
1761 options->cipher_xform.cipher.key.length);
1765 /* Set auth parameters */
1766 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH ||
1767 options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER ||
1768 options->xform_chain == L2FWD_CRYPTO_HASH_ONLY) {
1769 /* Check if device supports auth algo */
1771 opt_auth_algo = options->auth_xform.auth.algo;
1772 cap = &dev_info.capabilities[i];
1773 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1774 cap_auth_algo = cap->sym.auth.algo;
1775 if ((cap->sym.xform_type == RTE_CRYPTO_SYM_XFORM_AUTH) &&
1776 (cap_auth_algo == opt_auth_algo) &&
1777 (check_type(options, &dev_info) == 0)) {
1780 cap = &dev_info.capabilities[++i];
1783 if (cap->op == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1784 printf("Algorithm %s not supported by cryptodev %u"
1785 " or device not of preferred type (%s)\n",
1786 rte_crypto_auth_algorithm_strings[opt_auth_algo],
1788 options->string_type);
1792 check_iv_param(&cap->sym.auth.iv_size,
1793 options->auth_iv_param,
1794 options->auth_iv_random_size,
1795 &options->auth_iv.length);
1797 * Check if length of provided AAD is supported
1798 * by the algorithm chosen.
1800 if (options->aad_param) {
1801 if (check_supported_size(options->aad.length,
1802 cap->sym.auth.aad_size.min,
1803 cap->sym.auth.aad_size.max,
1804 cap->sym.auth.aad_size.increment)
1806 printf("Unsupported AAD length\n");
1810 * Check if length of AAD to be randomly generated
1811 * is supported by the algorithm chosen.
1813 } else if (options->aad_random_size != -1) {
1814 if (check_supported_size(options->aad_random_size,
1815 cap->sym.auth.aad_size.min,
1816 cap->sym.auth.aad_size.max,
1817 cap->sym.auth.aad_size.increment)
1819 printf("Unsupported AAD length\n");
1822 options->aad.length = options->aad_random_size;
1823 /* No size provided, use minimum size. */
1825 options->aad.length = cap->sym.auth.aad_size.min;
1827 options->auth_xform.auth.add_auth_data_length =
1828 options->aad.length;
1831 * Check if length of provided auth key is supported
1832 * by the algorithm chosen.
1834 if (options->akey_param) {
1835 if (check_supported_size(
1836 options->auth_xform.auth.key.length,
1837 cap->sym.auth.key_size.min,
1838 cap->sym.auth.key_size.max,
1839 cap->sym.auth.key_size.increment)
1841 printf("Unsupported auth key length\n");
1845 * Check if length of the auth key to be randomly generated
1846 * is supported by the algorithm chosen.
1848 } else if (options->akey_random_size != -1) {
1849 if (check_supported_size(options->akey_random_size,
1850 cap->sym.auth.key_size.min,
1851 cap->sym.auth.key_size.max,
1852 cap->sym.auth.key_size.increment)
1854 printf("Unsupported auth key length\n");
1857 options->auth_xform.auth.key.length =
1858 options->akey_random_size;
1859 /* No size provided, use minimum size. */
1861 options->auth_xform.auth.key.length =
1862 cap->sym.auth.key_size.min;
1864 if (!options->akey_param)
1865 generate_random_key(
1866 options->auth_xform.auth.key.data,
1867 options->auth_xform.auth.key.length);
1869 /* Check if digest size is supported by the algorithm. */
1870 if (options->digest_size != -1) {
1871 if (check_supported_size(options->digest_size,
1872 cap->sym.auth.digest_size.min,
1873 cap->sym.auth.digest_size.max,
1874 cap->sym.auth.digest_size.increment)
1876 printf("Unsupported digest length\n");
1879 options->auth_xform.auth.digest_length =
1880 options->digest_size;
1881 /* No size provided, use minimum size. */
1883 options->auth_xform.auth.digest_length =
1884 cap->sym.auth.digest_size.min;
1887 retval = rte_cryptodev_configure(cdev_id, &conf);
1889 printf("Failed to configure cryptodev %u", cdev_id);
1893 qp_conf.nb_descriptors = 2048;
1895 retval = rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf,
1898 printf("Failed to setup queue pair %u on cryptodev %u",
1903 retval = rte_cryptodev_start(cdev_id);
1905 printf("Failed to start device %u: error %d\n",
1910 l2fwd_enabled_crypto_mask |= (((uint64_t)1) << cdev_id);
1912 enabled_cdevs[cdev_id] = 1;
1913 enabled_cdev_count++;
1916 return enabled_cdev_count;
1920 initialize_ports(struct l2fwd_crypto_options *options)
1922 uint8_t last_portid, portid;
1923 unsigned enabled_portcount = 0;
1924 unsigned nb_ports = rte_eth_dev_count();
1926 if (nb_ports == 0) {
1927 printf("No Ethernet ports - bye\n");
1931 /* Reset l2fwd_dst_ports */
1932 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
1933 l2fwd_dst_ports[portid] = 0;
1935 for (last_portid = 0, portid = 0; portid < nb_ports; portid++) {
1938 /* Skip ports that are not enabled */
1939 if ((options->portmask & (1 << portid)) == 0)
1943 printf("Initializing port %u... ", (unsigned) portid);
1945 retval = rte_eth_dev_configure(portid, 1, 1, &port_conf);
1947 printf("Cannot configure device: err=%d, port=%u\n",
1948 retval, (unsigned) portid);
1952 /* init one RX queue */
1954 retval = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
1955 rte_eth_dev_socket_id(portid),
1956 NULL, l2fwd_pktmbuf_pool);
1958 printf("rte_eth_rx_queue_setup:err=%d, port=%u\n",
1959 retval, (unsigned) portid);
1963 /* init one TX queue on each port */
1965 retval = rte_eth_tx_queue_setup(portid, 0, nb_txd,
1966 rte_eth_dev_socket_id(portid),
1969 printf("rte_eth_tx_queue_setup:err=%d, port=%u\n",
1970 retval, (unsigned) portid);
1976 retval = rte_eth_dev_start(portid);
1978 printf("rte_eth_dev_start:err=%d, port=%u\n",
1979 retval, (unsigned) portid);
1983 rte_eth_promiscuous_enable(portid);
1985 rte_eth_macaddr_get(portid, &l2fwd_ports_eth_addr[portid]);
1987 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
1989 l2fwd_ports_eth_addr[portid].addr_bytes[0],
1990 l2fwd_ports_eth_addr[portid].addr_bytes[1],
1991 l2fwd_ports_eth_addr[portid].addr_bytes[2],
1992 l2fwd_ports_eth_addr[portid].addr_bytes[3],
1993 l2fwd_ports_eth_addr[portid].addr_bytes[4],
1994 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
1996 /* initialize port stats */
1997 memset(&port_statistics, 0, sizeof(port_statistics));
1999 /* Setup port forwarding table */
2000 if (enabled_portcount % 2) {
2001 l2fwd_dst_ports[portid] = last_portid;
2002 l2fwd_dst_ports[last_portid] = portid;
2004 last_portid = portid;
2007 l2fwd_enabled_port_mask |= (1 << portid);
2008 enabled_portcount++;
2011 if (enabled_portcount == 1) {
2012 l2fwd_dst_ports[last_portid] = last_portid;
2013 } else if (enabled_portcount % 2) {
2014 printf("odd number of ports in portmask- bye\n");
2018 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
2020 return enabled_portcount;
2024 reserve_key_memory(struct l2fwd_crypto_options *options)
2026 options->cipher_xform.cipher.key.data = rte_malloc("crypto key",
2028 if (options->cipher_xform.cipher.key.data == NULL)
2029 rte_exit(EXIT_FAILURE, "Failed to allocate memory for cipher key");
2032 options->auth_xform.auth.key.data = rte_malloc("auth key",
2034 if (options->auth_xform.auth.key.data == NULL)
2035 rte_exit(EXIT_FAILURE, "Failed to allocate memory for auth key");
2037 options->cipher_iv.data = rte_malloc("cipher iv", MAX_KEY_SIZE, 0);
2038 if (options->cipher_iv.data == NULL)
2039 rte_exit(EXIT_FAILURE, "Failed to allocate memory for cipher IV");
2041 options->auth_iv.data = rte_malloc("auth iv", MAX_KEY_SIZE, 0);
2042 if (options->auth_iv.data == NULL)
2043 rte_exit(EXIT_FAILURE, "Failed to allocate memory for auth IV");
2045 options->aad.data = rte_malloc("aad", MAX_KEY_SIZE, 0);
2046 if (options->aad.data == NULL)
2047 rte_exit(EXIT_FAILURE, "Failed to allocate memory for AAD");
2048 options->aad.phys_addr = rte_malloc_virt2phy(options->aad.data);
2052 main(int argc, char **argv)
2054 struct lcore_queue_conf *qconf;
2055 struct l2fwd_crypto_options options;
2057 uint8_t nb_ports, nb_cryptodevs, portid, cdev_id;
2058 unsigned lcore_id, rx_lcore_id;
2059 int ret, enabled_cdevcount, enabled_portcount;
2060 uint8_t enabled_cdevs[RTE_CRYPTO_MAX_DEVS] = {0};
2063 ret = rte_eal_init(argc, argv);
2065 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
2069 /* reserve memory for Cipher/Auth key and IV */
2070 reserve_key_memory(&options);
2072 /* parse application arguments (after the EAL ones) */
2073 ret = l2fwd_crypto_parse_args(&options, argc, argv);
2075 rte_exit(EXIT_FAILURE, "Invalid L2FWD-CRYPTO arguments\n");
2077 /* create the mbuf pool */
2078 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF, 512,
2079 sizeof(struct rte_crypto_op),
2080 RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
2081 if (l2fwd_pktmbuf_pool == NULL)
2082 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
2084 /* create crypto op pool */
2085 l2fwd_crypto_op_pool = rte_crypto_op_pool_create("crypto_op_pool",
2086 RTE_CRYPTO_OP_TYPE_SYMMETRIC, NB_MBUF, 128, MAXIMUM_IV_LENGTH,
2088 if (l2fwd_crypto_op_pool == NULL)
2089 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
2091 /* Enable Ethernet ports */
2092 enabled_portcount = initialize_ports(&options);
2093 if (enabled_portcount < 1)
2094 rte_exit(EXIT_FAILURE, "Failed to initial Ethernet ports\n");
2096 nb_ports = rte_eth_dev_count();
2097 /* Initialize the port/queue configuration of each logical core */
2098 for (rx_lcore_id = 0, qconf = NULL, portid = 0;
2099 portid < nb_ports; portid++) {
2101 /* skip ports that are not enabled */
2102 if ((options.portmask & (1 << portid)) == 0)
2105 if (options.single_lcore && qconf == NULL) {
2106 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
2108 if (rx_lcore_id >= RTE_MAX_LCORE)
2109 rte_exit(EXIT_FAILURE,
2110 "Not enough cores\n");
2112 } else if (!options.single_lcore) {
2113 /* get the lcore_id for this port */
2114 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
2115 lcore_queue_conf[rx_lcore_id].nb_rx_ports ==
2116 options.nb_ports_per_lcore) {
2118 if (rx_lcore_id >= RTE_MAX_LCORE)
2119 rte_exit(EXIT_FAILURE,
2120 "Not enough cores\n");
2124 /* Assigned a new logical core in the loop above. */
2125 if (qconf != &lcore_queue_conf[rx_lcore_id])
2126 qconf = &lcore_queue_conf[rx_lcore_id];
2128 qconf->rx_port_list[qconf->nb_rx_ports] = portid;
2129 qconf->nb_rx_ports++;
2131 printf("Lcore %u: RX port %u\n", rx_lcore_id, (unsigned)portid);
2134 /* Enable Crypto devices */
2135 enabled_cdevcount = initialize_cryptodevs(&options, enabled_portcount,
2137 if (enabled_cdevcount < 0)
2138 rte_exit(EXIT_FAILURE, "Failed to initialize crypto devices\n");
2140 if (enabled_cdevcount < enabled_portcount)
2141 rte_exit(EXIT_FAILURE, "Number of capable crypto devices (%d) "
2142 "has to be more or equal to number of ports (%d)\n",
2143 enabled_cdevcount, enabled_portcount);
2145 nb_cryptodevs = rte_cryptodev_count();
2147 /* Initialize the port/cryptodev configuration of each logical core */
2148 for (rx_lcore_id = 0, qconf = NULL, cdev_id = 0;
2149 cdev_id < nb_cryptodevs && enabled_cdevcount;
2151 /* Crypto op not supported by crypto device */
2152 if (!enabled_cdevs[cdev_id])
2155 if (options.single_lcore && qconf == NULL) {
2156 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
2158 if (rx_lcore_id >= RTE_MAX_LCORE)
2159 rte_exit(EXIT_FAILURE,
2160 "Not enough cores\n");
2162 } else if (!options.single_lcore) {
2163 /* get the lcore_id for this port */
2164 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
2165 lcore_queue_conf[rx_lcore_id].nb_crypto_devs ==
2166 options.nb_ports_per_lcore) {
2168 if (rx_lcore_id >= RTE_MAX_LCORE)
2169 rte_exit(EXIT_FAILURE,
2170 "Not enough cores\n");
2174 /* Assigned a new logical core in the loop above. */
2175 if (qconf != &lcore_queue_conf[rx_lcore_id])
2176 qconf = &lcore_queue_conf[rx_lcore_id];
2178 qconf->cryptodev_list[qconf->nb_crypto_devs] = cdev_id;
2179 qconf->nb_crypto_devs++;
2181 enabled_cdevcount--;
2183 printf("Lcore %u: cryptodev %u\n", rx_lcore_id,
2187 /* launch per-lcore init on every lcore */
2188 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, (void *)&options,
2190 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
2191 if (rte_eal_wait_lcore(lcore_id) < 0)