4 * Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/types.h>
41 #include <sys/queue.h>
42 #include <netinet/in.h>
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 */
93 * Configurable number of RX/TX ring descriptors
95 #define RTE_TEST_RX_DESC_DEFAULT 128
96 #define RTE_TEST_TX_DESC_DEFAULT 512
98 static uint16_t nb_rxd = RTE_TEST_RX_DESC_DEFAULT;
99 static uint16_t nb_txd = RTE_TEST_TX_DESC_DEFAULT;
101 /* ethernet addresses of ports */
102 static struct ether_addr l2fwd_ports_eth_addr[RTE_MAX_ETHPORTS];
104 /* mask of enabled ports */
105 static uint64_t l2fwd_enabled_port_mask;
106 static uint64_t l2fwd_enabled_crypto_mask;
108 /* list of enabled ports */
109 static uint32_t l2fwd_dst_ports[RTE_MAX_ETHPORTS];
114 struct rte_mbuf *buffer[MAX_PKT_BURST];
119 struct rte_crypto_op *buffer[MAX_PKT_BURST];
122 #define MAX_RX_QUEUE_PER_LCORE 16
123 #define MAX_TX_QUEUE_PER_PORT 16
125 enum l2fwd_crypto_xform_chain {
126 L2FWD_CRYPTO_CIPHER_HASH,
127 L2FWD_CRYPTO_HASH_CIPHER,
128 L2FWD_CRYPTO_CIPHER_ONLY,
129 L2FWD_CRYPTO_HASH_ONLY
135 phys_addr_t phys_addr;
138 char supported_auth_algo[RTE_CRYPTO_AUTH_LIST_END][MAX_STR_LEN];
139 char supported_cipher_algo[RTE_CRYPTO_CIPHER_LIST_END][MAX_STR_LEN];
141 /** l2fwd crypto application command line options */
142 struct l2fwd_crypto_options {
144 unsigned nb_ports_per_lcore;
145 unsigned refresh_period;
146 unsigned single_lcore:1;
149 unsigned sessionless:1;
151 enum l2fwd_crypto_xform_chain xform_chain;
153 struct rte_crypto_sym_xform cipher_xform;
155 int ckey_random_size;
161 struct rte_crypto_sym_xform auth_xform;
163 int akey_random_size;
165 struct l2fwd_key aad;
172 char string_type[MAX_STR_LEN];
175 /** l2fwd crypto lcore params */
176 struct l2fwd_crypto_params {
180 unsigned digest_length;
184 struct l2fwd_key aad;
185 struct rte_cryptodev_sym_session *session;
191 enum rte_crypto_cipher_algorithm cipher_algo;
192 enum rte_crypto_auth_algorithm auth_algo;
195 /** lcore configuration */
196 struct lcore_queue_conf {
197 unsigned nb_rx_ports;
198 unsigned rx_port_list[MAX_RX_QUEUE_PER_LCORE];
200 unsigned nb_crypto_devs;
201 unsigned cryptodev_list[MAX_RX_QUEUE_PER_LCORE];
203 struct op_buffer op_buf[RTE_CRYPTO_MAX_DEVS];
204 struct pkt_buffer pkt_buf[RTE_MAX_ETHPORTS];
205 } __rte_cache_aligned;
207 struct lcore_queue_conf lcore_queue_conf[RTE_MAX_LCORE];
209 static const struct rte_eth_conf port_conf = {
211 .mq_mode = ETH_MQ_RX_NONE,
212 .max_rx_pkt_len = ETHER_MAX_LEN,
214 .header_split = 0, /**< Header Split disabled */
215 .hw_ip_checksum = 0, /**< IP checksum offload disabled */
216 .hw_vlan_filter = 0, /**< VLAN filtering disabled */
217 .jumbo_frame = 0, /**< Jumbo Frame Support disabled */
218 .hw_strip_crc = 1, /**< CRC stripped by hardware */
221 .mq_mode = ETH_MQ_TX_NONE,
225 struct rte_mempool *l2fwd_pktmbuf_pool;
226 struct rte_mempool *l2fwd_crypto_op_pool;
228 /* Per-port statistics struct */
229 struct l2fwd_port_statistics {
233 uint64_t crypto_enqueued;
234 uint64_t crypto_dequeued;
237 } __rte_cache_aligned;
239 struct l2fwd_crypto_statistics {
244 } __rte_cache_aligned;
246 struct l2fwd_port_statistics port_statistics[RTE_MAX_ETHPORTS];
247 struct l2fwd_crypto_statistics crypto_statistics[RTE_CRYPTO_MAX_DEVS];
249 /* A tsc-based timer responsible for triggering statistics printout */
250 #define TIMER_MILLISECOND 2000000ULL /* around 1ms at 2 Ghz */
251 #define MAX_TIMER_PERIOD 86400UL /* 1 day max */
253 /* default period is 10 seconds */
254 static int64_t timer_period = 10 * TIMER_MILLISECOND * 1000;
256 /* Print out statistics on packets dropped */
260 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
261 uint64_t total_packets_enqueued, total_packets_dequeued,
262 total_packets_errors;
266 total_packets_dropped = 0;
267 total_packets_tx = 0;
268 total_packets_rx = 0;
269 total_packets_enqueued = 0;
270 total_packets_dequeued = 0;
271 total_packets_errors = 0;
273 const char clr[] = { 27, '[', '2', 'J', '\0' };
274 const char topLeft[] = { 27, '[', '1', ';', '1', 'H', '\0' };
276 /* Clear screen and move to top left */
277 printf("%s%s", clr, topLeft);
279 printf("\nPort statistics ====================================");
281 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
282 /* skip disabled ports */
283 if ((l2fwd_enabled_port_mask & (1 << portid)) == 0)
285 printf("\nStatistics for port %u ------------------------------"
286 "\nPackets sent: %32"PRIu64
287 "\nPackets received: %28"PRIu64
288 "\nPackets dropped: %29"PRIu64,
290 port_statistics[portid].tx,
291 port_statistics[portid].rx,
292 port_statistics[portid].dropped);
294 total_packets_dropped += port_statistics[portid].dropped;
295 total_packets_tx += port_statistics[portid].tx;
296 total_packets_rx += port_statistics[portid].rx;
298 printf("\nCrypto statistics ==================================");
300 for (cdevid = 0; cdevid < RTE_CRYPTO_MAX_DEVS; cdevid++) {
301 /* skip disabled ports */
302 if ((l2fwd_enabled_crypto_mask & (((uint64_t)1) << cdevid)) == 0)
304 printf("\nStatistics for cryptodev %"PRIu64
305 " -------------------------"
306 "\nPackets enqueued: %28"PRIu64
307 "\nPackets dequeued: %28"PRIu64
308 "\nPackets errors: %30"PRIu64,
310 crypto_statistics[cdevid].enqueued,
311 crypto_statistics[cdevid].dequeued,
312 crypto_statistics[cdevid].errors);
314 total_packets_enqueued += crypto_statistics[cdevid].enqueued;
315 total_packets_dequeued += crypto_statistics[cdevid].dequeued;
316 total_packets_errors += crypto_statistics[cdevid].errors;
318 printf("\nAggregate statistics ==============================="
319 "\nTotal packets received: %22"PRIu64
320 "\nTotal packets enqueued: %22"PRIu64
321 "\nTotal packets dequeued: %22"PRIu64
322 "\nTotal packets sent: %26"PRIu64
323 "\nTotal packets dropped: %23"PRIu64
324 "\nTotal packets crypto errors: %17"PRIu64,
326 total_packets_enqueued,
327 total_packets_dequeued,
329 total_packets_dropped,
330 total_packets_errors);
331 printf("\n====================================================\n");
335 fill_supported_algorithm_tables(void)
339 for (i = 0; i < RTE_CRYPTO_AUTH_LIST_END; i++)
340 strcpy(supported_auth_algo[i], "NOT_SUPPORTED");
342 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_AES_GCM], "AES_GCM");
343 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_AES_GMAC], "AES_GMAC");
344 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_MD5_HMAC], "MD5_HMAC");
345 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_MD5], "MD5");
346 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_NULL], "NULL");
347 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_AES_XCBC_MAC],
349 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA1_HMAC], "SHA1_HMAC");
350 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA1], "SHA1");
351 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA224_HMAC], "SHA224_HMAC");
352 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA224], "SHA224");
353 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA256_HMAC], "SHA256_HMAC");
354 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA256], "SHA256");
355 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA384_HMAC], "SHA384_HMAC");
356 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA384], "SHA384");
357 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA512_HMAC], "SHA512_HMAC");
358 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SHA512], "SHA512");
359 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_SNOW3G_UIA2], "SNOW3G_UIA2");
360 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_ZUC_EIA3], "ZUC_EIA3");
361 strcpy(supported_auth_algo[RTE_CRYPTO_AUTH_KASUMI_F9], "KASUMI_F9");
363 for (i = 0; i < RTE_CRYPTO_CIPHER_LIST_END; i++)
364 strcpy(supported_cipher_algo[i], "NOT_SUPPORTED");
366 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_AES_CBC], "AES_CBC");
367 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_AES_CTR], "AES_CTR");
368 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_AES_GCM], "AES_GCM");
369 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_NULL], "NULL");
370 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_SNOW3G_UEA2], "SNOW3G_UEA2");
371 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_ZUC_EEA3], "ZUC_EEA3");
372 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_KASUMI_F8], "KASUMI_F8");
373 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_3DES_CTR], "3DES_CTR");
374 strcpy(supported_cipher_algo[RTE_CRYPTO_CIPHER_3DES_CBC], "3DES_CBC");
379 l2fwd_crypto_send_burst(struct lcore_queue_conf *qconf, unsigned n,
380 struct l2fwd_crypto_params *cparams)
382 struct rte_crypto_op **op_buffer;
385 op_buffer = (struct rte_crypto_op **)
386 qconf->op_buf[cparams->dev_id].buffer;
388 ret = rte_cryptodev_enqueue_burst(cparams->dev_id,
389 cparams->qp_id, op_buffer, (uint16_t) n);
391 crypto_statistics[cparams->dev_id].enqueued += ret;
392 if (unlikely(ret < n)) {
393 crypto_statistics[cparams->dev_id].errors += (n - ret);
395 rte_pktmbuf_free(op_buffer[ret]->sym->m_src);
396 rte_crypto_op_free(op_buffer[ret]);
404 l2fwd_crypto_enqueue(struct rte_crypto_op *op,
405 struct l2fwd_crypto_params *cparams)
407 unsigned lcore_id, len;
408 struct lcore_queue_conf *qconf;
410 lcore_id = rte_lcore_id();
412 qconf = &lcore_queue_conf[lcore_id];
413 len = qconf->op_buf[cparams->dev_id].len;
414 qconf->op_buf[cparams->dev_id].buffer[len] = op;
417 /* enough ops to be sent */
418 if (len == MAX_PKT_BURST) {
419 l2fwd_crypto_send_burst(qconf, MAX_PKT_BURST, cparams);
423 qconf->op_buf[cparams->dev_id].len = len;
428 l2fwd_simple_crypto_enqueue(struct rte_mbuf *m,
429 struct rte_crypto_op *op,
430 struct l2fwd_crypto_params *cparams)
432 struct ether_hdr *eth_hdr;
433 struct ipv4_hdr *ip_hdr;
435 uint32_t ipdata_offset, data_len;
436 uint32_t pad_len = 0;
439 eth_hdr = rte_pktmbuf_mtod(m, struct ether_hdr *);
441 if (eth_hdr->ether_type != rte_cpu_to_be_16(ETHER_TYPE_IPv4))
444 ipdata_offset = sizeof(struct ether_hdr);
446 ip_hdr = (struct ipv4_hdr *)(rte_pktmbuf_mtod(m, char *) +
449 ipdata_offset += (ip_hdr->version_ihl & IPV4_HDR_IHL_MASK)
450 * IPV4_IHL_MULTIPLIER;
453 /* Zero pad data to be crypto'd so it is block aligned */
454 data_len = rte_pktmbuf_data_len(m) - ipdata_offset;
456 if (cparams->do_hash && cparams->hash_verify)
457 data_len -= cparams->digest_length;
459 if (cparams->do_cipher) {
461 * Following algorithms are block cipher algorithms,
462 * and might need padding
464 switch (cparams->cipher_algo) {
465 case RTE_CRYPTO_CIPHER_AES_CBC:
466 case RTE_CRYPTO_CIPHER_AES_ECB:
467 case RTE_CRYPTO_CIPHER_3DES_CBC:
468 case RTE_CRYPTO_CIPHER_3DES_ECB:
469 if (data_len % cparams->block_size)
470 pad_len = cparams->block_size -
471 (data_len % cparams->block_size);
478 padding = rte_pktmbuf_append(m, pad_len);
479 if (unlikely(!padding))
483 memset(padding, 0, pad_len);
487 /* Set crypto operation data parameters */
488 rte_crypto_op_attach_sym_session(op, cparams->session);
490 if (cparams->do_hash) {
491 if (!cparams->hash_verify) {
492 /* Append space for digest to end of packet */
493 op->sym->auth.digest.data = (uint8_t *)rte_pktmbuf_append(m,
494 cparams->digest_length);
496 op->sym->auth.digest.data = rte_pktmbuf_mtod(m,
497 uint8_t *) + ipdata_offset + data_len;
500 op->sym->auth.digest.phys_addr = rte_pktmbuf_mtophys_offset(m,
501 rte_pktmbuf_pkt_len(m) - cparams->digest_length);
502 op->sym->auth.digest.length = cparams->digest_length;
504 /* For wireless algorithms, offset/length must be in bits */
505 if (cparams->auth_algo == RTE_CRYPTO_AUTH_SNOW3G_UIA2 ||
506 cparams->auth_algo == RTE_CRYPTO_AUTH_KASUMI_F9 ||
507 cparams->auth_algo == RTE_CRYPTO_AUTH_ZUC_EIA3) {
508 op->sym->auth.data.offset = ipdata_offset << 3;
509 op->sym->auth.data.length = data_len << 3;
511 op->sym->auth.data.offset = ipdata_offset;
512 op->sym->auth.data.length = data_len;
515 if (cparams->aad.length) {
516 op->sym->auth.aad.data = cparams->aad.data;
517 op->sym->auth.aad.phys_addr = cparams->aad.phys_addr;
518 op->sym->auth.aad.length = cparams->aad.length;
520 op->sym->auth.aad.data = NULL;
521 op->sym->auth.aad.phys_addr = 0;
522 op->sym->auth.aad.length = 0;
526 if (cparams->do_cipher) {
527 op->sym->cipher.iv.data = cparams->iv.data;
528 op->sym->cipher.iv.phys_addr = cparams->iv.phys_addr;
529 op->sym->cipher.iv.length = cparams->iv.length;
531 /* For wireless algorithms, offset/length must be in bits */
532 if (cparams->cipher_algo == RTE_CRYPTO_CIPHER_SNOW3G_UEA2 ||
533 cparams->cipher_algo == RTE_CRYPTO_CIPHER_KASUMI_F8 ||
534 cparams->cipher_algo == RTE_CRYPTO_CIPHER_ZUC_EEA3) {
535 op->sym->cipher.data.offset = ipdata_offset << 3;
536 op->sym->cipher.data.length = data_len << 3;
538 op->sym->cipher.data.offset = ipdata_offset;
539 op->sym->cipher.data.length = data_len;
545 return l2fwd_crypto_enqueue(op, cparams);
549 /* Send the burst of packets on an output interface */
551 l2fwd_send_burst(struct lcore_queue_conf *qconf, unsigned n,
554 struct rte_mbuf **pkt_buffer;
557 pkt_buffer = (struct rte_mbuf **)qconf->pkt_buf[port].buffer;
559 ret = rte_eth_tx_burst(port, 0, pkt_buffer, (uint16_t)n);
560 port_statistics[port].tx += ret;
561 if (unlikely(ret < n)) {
562 port_statistics[port].dropped += (n - ret);
564 rte_pktmbuf_free(pkt_buffer[ret]);
571 /* Enqueue packets for TX and prepare them to be sent */
573 l2fwd_send_packet(struct rte_mbuf *m, uint8_t port)
575 unsigned lcore_id, len;
576 struct lcore_queue_conf *qconf;
578 lcore_id = rte_lcore_id();
580 qconf = &lcore_queue_conf[lcore_id];
581 len = qconf->pkt_buf[port].len;
582 qconf->pkt_buf[port].buffer[len] = m;
585 /* enough pkts to be sent */
586 if (unlikely(len == MAX_PKT_BURST)) {
587 l2fwd_send_burst(qconf, MAX_PKT_BURST, port);
591 qconf->pkt_buf[port].len = len;
596 l2fwd_simple_forward(struct rte_mbuf *m, unsigned portid)
598 struct ether_hdr *eth;
602 dst_port = l2fwd_dst_ports[portid];
603 eth = rte_pktmbuf_mtod(m, struct ether_hdr *);
605 /* 02:00:00:00:00:xx */
606 tmp = ð->d_addr.addr_bytes[0];
607 *((uint64_t *)tmp) = 0x000000000002 + ((uint64_t)dst_port << 40);
610 ether_addr_copy(&l2fwd_ports_eth_addr[dst_port], ð->s_addr);
612 l2fwd_send_packet(m, (uint8_t) dst_port);
615 /** Generate random key */
617 generate_random_key(uint8_t *key, unsigned length)
622 fd = open("/dev/urandom", O_RDONLY);
624 rte_exit(EXIT_FAILURE, "Failed to generate random key\n");
626 ret = read(fd, key, length);
629 if (ret != (signed)length)
630 rte_exit(EXIT_FAILURE, "Failed to generate random key\n");
633 static struct rte_cryptodev_sym_session *
634 initialize_crypto_session(struct l2fwd_crypto_options *options,
637 struct rte_crypto_sym_xform *first_xform;
639 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH) {
640 first_xform = &options->cipher_xform;
641 first_xform->next = &options->auth_xform;
642 } else if (options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER) {
643 first_xform = &options->auth_xform;
644 first_xform->next = &options->cipher_xform;
645 } else if (options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
646 first_xform = &options->cipher_xform;
648 first_xform = &options->auth_xform;
651 /* Setup Cipher Parameters */
652 return rte_cryptodev_sym_session_create(cdev_id, first_xform);
656 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options);
658 /* main processing loop */
660 l2fwd_main_loop(struct l2fwd_crypto_options *options)
662 struct rte_mbuf *m, *pkts_burst[MAX_PKT_BURST];
663 struct rte_crypto_op *ops_burst[MAX_PKT_BURST];
665 unsigned lcore_id = rte_lcore_id();
666 uint64_t prev_tsc = 0, diff_tsc, cur_tsc, timer_tsc = 0;
667 unsigned i, j, portid, nb_rx, len;
668 struct lcore_queue_conf *qconf = &lcore_queue_conf[lcore_id];
669 const uint64_t drain_tsc = (rte_get_tsc_hz() + US_PER_S - 1) /
670 US_PER_S * BURST_TX_DRAIN_US;
671 struct l2fwd_crypto_params *cparams;
672 struct l2fwd_crypto_params port_cparams[qconf->nb_crypto_devs];
674 if (qconf->nb_rx_ports == 0) {
675 RTE_LOG(INFO, L2FWD, "lcore %u has nothing to do\n", lcore_id);
679 RTE_LOG(INFO, L2FWD, "entering main loop on lcore %u\n", lcore_id);
681 for (i = 0; i < qconf->nb_rx_ports; i++) {
683 portid = qconf->rx_port_list[i];
684 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u portid=%u\n", lcore_id,
688 for (i = 0; i < qconf->nb_crypto_devs; i++) {
689 port_cparams[i].do_cipher = 0;
690 port_cparams[i].do_hash = 0;
692 switch (options->xform_chain) {
693 case L2FWD_CRYPTO_CIPHER_HASH:
694 case L2FWD_CRYPTO_HASH_CIPHER:
695 port_cparams[i].do_cipher = 1;
696 port_cparams[i].do_hash = 1;
698 case L2FWD_CRYPTO_HASH_ONLY:
699 port_cparams[i].do_hash = 1;
701 case L2FWD_CRYPTO_CIPHER_ONLY:
702 port_cparams[i].do_cipher = 1;
706 port_cparams[i].dev_id = qconf->cryptodev_list[i];
707 port_cparams[i].qp_id = 0;
709 port_cparams[i].block_size = options->block_size;
711 if (port_cparams[i].do_hash) {
712 port_cparams[i].digest_length =
713 options->auth_xform.auth.digest_length;
714 if (options->auth_xform.auth.add_auth_data_length) {
715 port_cparams[i].aad.data = options->aad.data;
716 port_cparams[i].aad.length =
717 options->auth_xform.auth.add_auth_data_length;
718 port_cparams[i].aad.phys_addr = options->aad.phys_addr;
719 if (!options->aad_param)
720 generate_random_key(port_cparams[i].aad.data,
721 port_cparams[i].aad.length);
724 port_cparams[i].aad.length = 0;
726 if (options->auth_xform.auth.op == RTE_CRYPTO_AUTH_OP_VERIFY)
727 port_cparams[i].hash_verify = 1;
729 port_cparams[i].hash_verify = 0;
731 port_cparams[i].auth_algo = options->auth_xform.auth.algo;
734 if (port_cparams[i].do_cipher) {
735 port_cparams[i].iv.data = options->iv.data;
736 port_cparams[i].iv.length = options->iv.length;
737 port_cparams[i].iv.phys_addr = options->iv.phys_addr;
738 if (!options->iv_param)
739 generate_random_key(port_cparams[i].iv.data,
740 port_cparams[i].iv.length);
742 port_cparams[i].cipher_algo = options->cipher_xform.cipher.algo;
745 port_cparams[i].session = initialize_crypto_session(options,
746 port_cparams[i].dev_id);
748 if (port_cparams[i].session == NULL)
750 RTE_LOG(INFO, L2FWD, " -- lcoreid=%u cryptoid=%u\n", lcore_id,
751 port_cparams[i].dev_id);
754 l2fwd_crypto_options_print(options);
757 * Initialize previous tsc timestamp before the loop,
758 * to avoid showing the port statistics immediately,
759 * so user can see the crypto information.
761 prev_tsc = rte_rdtsc();
764 cur_tsc = rte_rdtsc();
767 * Crypto device/TX burst queue drain
769 diff_tsc = cur_tsc - prev_tsc;
770 if (unlikely(diff_tsc > drain_tsc)) {
771 /* Enqueue all crypto ops remaining in buffers */
772 for (i = 0; i < qconf->nb_crypto_devs; i++) {
773 cparams = &port_cparams[i];
774 len = qconf->op_buf[cparams->dev_id].len;
775 l2fwd_crypto_send_burst(qconf, len, cparams);
776 qconf->op_buf[cparams->dev_id].len = 0;
778 /* Transmit all packets remaining in buffers */
779 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++) {
780 if (qconf->pkt_buf[portid].len == 0)
782 l2fwd_send_burst(&lcore_queue_conf[lcore_id],
783 qconf->pkt_buf[portid].len,
785 qconf->pkt_buf[portid].len = 0;
788 /* if timer is enabled */
789 if (timer_period > 0) {
791 /* advance the timer */
792 timer_tsc += diff_tsc;
794 /* if timer has reached its timeout */
795 if (unlikely(timer_tsc >=
796 (uint64_t)timer_period)) {
798 /* do this only on master core */
799 if (lcore_id == rte_get_master_lcore()
800 && options->refresh_period) {
811 * Read packet from RX queues
813 for (i = 0; i < qconf->nb_rx_ports; i++) {
814 portid = qconf->rx_port_list[i];
816 cparams = &port_cparams[i];
818 nb_rx = rte_eth_rx_burst((uint8_t) portid, 0,
819 pkts_burst, MAX_PKT_BURST);
821 port_statistics[portid].rx += nb_rx;
825 * If we can't allocate a crypto_ops, then drop
826 * the rest of the burst and dequeue and
827 * process the packets to free offload structs
829 if (rte_crypto_op_bulk_alloc(
830 l2fwd_crypto_op_pool,
831 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
834 for (j = 0; j < nb_rx; j++)
835 rte_pktmbuf_free(pkts_burst[j]);
840 /* Enqueue packets from Crypto device*/
841 for (j = 0; j < nb_rx; j++) {
844 l2fwd_simple_crypto_enqueue(m,
845 ops_burst[j], cparams);
849 /* Dequeue packets from Crypto device */
851 nb_rx = rte_cryptodev_dequeue_burst(
852 cparams->dev_id, cparams->qp_id,
853 ops_burst, MAX_PKT_BURST);
855 crypto_statistics[cparams->dev_id].dequeued +=
858 /* Forward crypto'd packets */
859 for (j = 0; j < nb_rx; j++) {
860 m = ops_burst[j]->sym->m_src;
862 rte_crypto_op_free(ops_burst[j]);
863 l2fwd_simple_forward(m, portid);
865 } while (nb_rx == MAX_PKT_BURST);
871 l2fwd_launch_one_lcore(void *arg)
873 l2fwd_main_loop((struct l2fwd_crypto_options *)arg);
877 /* Display command line arguments usage */
879 l2fwd_crypto_usage(const char *prgname)
881 printf("%s [EAL options] --\n"
882 " -p PORTMASK: hexadecimal bitmask of ports to configure\n"
883 " -q NQ: number of queue (=ports) per lcore (default is 1)\n"
884 " -s manage all ports from single lcore\n"
885 " -T PERIOD: statistics will be refreshed each PERIOD seconds"
886 " (0 to disable, 10 default, 86400 maximum)\n"
888 " --cdev_type HW / SW / ANY\n"
889 " --chain HASH_CIPHER / CIPHER_HASH / CIPHER_ONLY /"
892 " --cipher_algo ALGO\n"
893 " --cipher_op ENCRYPT / DECRYPT\n"
894 " --cipher_key KEY (bytes separated with \":\")\n"
895 " --cipher_key_random_size SIZE: size of cipher key when generated randomly\n"
896 " --iv IV (bytes separated with \":\")\n"
897 " --iv_random_size SIZE: size of IV when generated randomly\n"
899 " --auth_algo ALGO\n"
900 " --auth_op GENERATE / VERIFY\n"
901 " --auth_key KEY (bytes separated with \":\")\n"
902 " --auth_key_random_size SIZE: size of auth key when generated randomly\n"
903 " --aad AAD (bytes separated with \":\")\n"
904 " --aad_random_size SIZE: size of AAD when generated randomly\n"
905 " --digest_size SIZE: size of digest to be generated/verified\n"
911 /** Parse crypto device type command line argument */
913 parse_cryptodev_type(enum cdev_type *type, char *optarg)
915 if (strcmp("HW", optarg) == 0) {
916 *type = CDEV_TYPE_HW;
918 } else if (strcmp("SW", optarg) == 0) {
919 *type = CDEV_TYPE_SW;
921 } else if (strcmp("ANY", optarg) == 0) {
922 *type = CDEV_TYPE_ANY;
929 /** Parse crypto chain xform command line argument */
931 parse_crypto_opt_chain(struct l2fwd_crypto_options *options, char *optarg)
933 if (strcmp("CIPHER_HASH", optarg) == 0) {
934 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
936 } else if (strcmp("HASH_CIPHER", optarg) == 0) {
937 options->xform_chain = L2FWD_CRYPTO_HASH_CIPHER;
939 } else if (strcmp("CIPHER_ONLY", optarg) == 0) {
940 options->xform_chain = L2FWD_CRYPTO_CIPHER_ONLY;
942 } else if (strcmp("HASH_ONLY", optarg) == 0) {
943 options->xform_chain = L2FWD_CRYPTO_HASH_ONLY;
950 /** Parse crypto cipher algo option command line argument */
952 parse_cipher_algo(enum rte_crypto_cipher_algorithm *algo, char *optarg)
956 for (i = 0; i < RTE_CRYPTO_CIPHER_LIST_END; i++) {
957 if (!strcmp(supported_cipher_algo[i], optarg)) {
958 *algo = (enum rte_crypto_cipher_algorithm)i;
963 printf("Cipher algorithm not supported!\n");
967 /** Parse crypto cipher operation command line argument */
969 parse_cipher_op(enum rte_crypto_cipher_operation *op, char *optarg)
971 if (strcmp("ENCRYPT", optarg) == 0) {
972 *op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
974 } else if (strcmp("DECRYPT", optarg) == 0) {
975 *op = RTE_CRYPTO_CIPHER_OP_DECRYPT;
979 printf("Cipher operation not supported!\n");
983 /** Parse crypto key command line argument */
985 parse_key(uint8_t *data, char *input_arg)
991 for (byte_count = 0, token = strtok(input_arg, ":");
992 (byte_count < MAX_KEY_SIZE) && (token != NULL);
993 token = strtok(NULL, ":")) {
995 int number = (int)strtol(token, NULL, 16);
997 if (errno == EINVAL || errno == ERANGE || number > 0xFF)
1000 data[byte_count++] = (uint8_t)number;
1006 /** Parse size param*/
1008 parse_size(int *size, const char *q_arg)
1013 /* parse hexadecimal string */
1014 n = strtoul(q_arg, &end, 10);
1015 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1019 printf("invalid size\n");
1027 /** Parse crypto cipher operation command line argument */
1029 parse_auth_algo(enum rte_crypto_auth_algorithm *algo, char *optarg)
1033 for (i = 0; i < RTE_CRYPTO_AUTH_LIST_END; i++) {
1034 if (!strcmp(supported_auth_algo[i], optarg)) {
1035 *algo = (enum rte_crypto_auth_algorithm)i;
1040 printf("Authentication algorithm specified not supported!\n");
1045 parse_auth_op(enum rte_crypto_auth_operation *op, char *optarg)
1047 if (strcmp("VERIFY", optarg) == 0) {
1048 *op = RTE_CRYPTO_AUTH_OP_VERIFY;
1050 } else if (strcmp("GENERATE", optarg) == 0) {
1051 *op = RTE_CRYPTO_AUTH_OP_GENERATE;
1055 printf("Authentication operation specified not supported!\n");
1059 /** Parse long options */
1061 l2fwd_crypto_parse_args_long_options(struct l2fwd_crypto_options *options,
1062 struct option *lgopts, int option_index)
1066 if (strcmp(lgopts[option_index].name, "cdev_type") == 0) {
1067 retval = parse_cryptodev_type(&options->type, optarg);
1069 snprintf(options->string_type, MAX_STR_LEN,
1074 else if (strcmp(lgopts[option_index].name, "chain") == 0)
1075 return parse_crypto_opt_chain(options, optarg);
1077 /* Cipher options */
1078 else if (strcmp(lgopts[option_index].name, "cipher_algo") == 0)
1079 return parse_cipher_algo(&options->cipher_xform.cipher.algo,
1082 else if (strcmp(lgopts[option_index].name, "cipher_op") == 0)
1083 return parse_cipher_op(&options->cipher_xform.cipher.op,
1086 else if (strcmp(lgopts[option_index].name, "cipher_key") == 0) {
1087 options->ckey_param = 1;
1088 options->cipher_xform.cipher.key.length =
1089 parse_key(options->cipher_xform.cipher.key.data, optarg);
1090 if (options->cipher_xform.cipher.key.length > 0)
1096 else if (strcmp(lgopts[option_index].name, "cipher_key_random_size") == 0)
1097 return parse_size(&options->ckey_random_size, optarg);
1099 else if (strcmp(lgopts[option_index].name, "iv") == 0) {
1100 options->iv_param = 1;
1101 options->iv.length =
1102 parse_key(options->iv.data, optarg);
1103 if (options->iv.length > 0)
1109 else if (strcmp(lgopts[option_index].name, "iv_random_size") == 0)
1110 return parse_size(&options->iv_random_size, optarg);
1112 /* Authentication options */
1113 else if (strcmp(lgopts[option_index].name, "auth_algo") == 0) {
1114 return parse_auth_algo(&options->auth_xform.auth.algo,
1118 else if (strcmp(lgopts[option_index].name, "auth_op") == 0)
1119 return parse_auth_op(&options->auth_xform.auth.op,
1122 else if (strcmp(lgopts[option_index].name, "auth_key") == 0) {
1123 options->akey_param = 1;
1124 options->auth_xform.auth.key.length =
1125 parse_key(options->auth_xform.auth.key.data, optarg);
1126 if (options->auth_xform.auth.key.length > 0)
1132 else if (strcmp(lgopts[option_index].name, "auth_key_random_size") == 0) {
1133 return parse_size(&options->akey_random_size, optarg);
1136 else if (strcmp(lgopts[option_index].name, "aad") == 0) {
1137 options->aad_param = 1;
1138 options->aad.length =
1139 parse_key(options->aad.data, optarg);
1140 if (options->aad.length > 0)
1146 else if (strcmp(lgopts[option_index].name, "aad_random_size") == 0) {
1147 return parse_size(&options->aad_random_size, optarg);
1150 else if (strcmp(lgopts[option_index].name, "digest_size") == 0) {
1151 return parse_size(&options->digest_size, optarg);
1154 else if (strcmp(lgopts[option_index].name, "sessionless") == 0) {
1155 options->sessionless = 1;
1162 /** Parse port mask */
1164 l2fwd_crypto_parse_portmask(struct l2fwd_crypto_options *options,
1170 /* parse hexadecimal string */
1171 pm = strtoul(q_arg, &end, 16);
1172 if ((pm == '\0') || (end == NULL) || (*end != '\0'))
1175 options->portmask = pm;
1176 if (options->portmask == 0) {
1177 printf("invalid portmask specified\n");
1184 /** Parse number of queues */
1186 l2fwd_crypto_parse_nqueue(struct l2fwd_crypto_options *options,
1192 /* parse hexadecimal string */
1193 n = strtoul(q_arg, &end, 10);
1194 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1196 else if (n >= MAX_RX_QUEUE_PER_LCORE)
1199 options->nb_ports_per_lcore = n;
1200 if (options->nb_ports_per_lcore == 0) {
1201 printf("invalid number of ports selected\n");
1208 /** Parse timer period */
1210 l2fwd_crypto_parse_timer_period(struct l2fwd_crypto_options *options,
1216 /* parse number string */
1217 n = (unsigned)strtol(q_arg, &end, 10);
1218 if ((q_arg[0] == '\0') || (end == NULL) || (*end != '\0'))
1221 if (n >= MAX_TIMER_PERIOD) {
1222 printf("Warning refresh period specified %lu is greater than "
1223 "max value %lu! using max value",
1224 n, MAX_TIMER_PERIOD);
1225 n = MAX_TIMER_PERIOD;
1228 options->refresh_period = n * 1000 * TIMER_MILLISECOND;
1233 /** Generate default options for application */
1235 l2fwd_crypto_default_options(struct l2fwd_crypto_options *options)
1237 options->portmask = 0xffffffff;
1238 options->nb_ports_per_lcore = 1;
1239 options->refresh_period = 10000;
1240 options->single_lcore = 0;
1241 options->sessionless = 0;
1243 options->xform_chain = L2FWD_CRYPTO_CIPHER_HASH;
1246 options->cipher_xform.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
1247 options->cipher_xform.next = NULL;
1248 options->ckey_param = 0;
1249 options->ckey_random_size = -1;
1250 options->cipher_xform.cipher.key.length = 0;
1251 options->iv_param = 0;
1252 options->iv_random_size = -1;
1253 options->iv.length = 0;
1255 options->cipher_xform.cipher.algo = RTE_CRYPTO_CIPHER_AES_CBC;
1256 options->cipher_xform.cipher.op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
1258 /* Authentication Data */
1259 options->auth_xform.type = RTE_CRYPTO_SYM_XFORM_AUTH;
1260 options->auth_xform.next = NULL;
1261 options->akey_param = 0;
1262 options->akey_random_size = -1;
1263 options->auth_xform.auth.key.length = 0;
1264 options->aad_param = 0;
1265 options->aad_random_size = -1;
1266 options->aad.length = 0;
1267 options->digest_size = -1;
1269 options->auth_xform.auth.algo = RTE_CRYPTO_AUTH_SHA1_HMAC;
1270 options->auth_xform.auth.op = RTE_CRYPTO_AUTH_OP_GENERATE;
1272 options->type = CDEV_TYPE_ANY;
1276 display_cipher_info(struct l2fwd_crypto_options *options)
1278 printf("\n---- Cipher information ---\n");
1279 printf("Algorithm: %s\n",
1280 supported_cipher_algo[options->cipher_xform.cipher.algo]);
1281 rte_hexdump(stdout, "Cipher key:",
1282 options->cipher_xform.cipher.key.data,
1283 options->cipher_xform.cipher.key.length);
1284 rte_hexdump(stdout, "IV:", options->iv.data, options->iv.length);
1288 display_auth_info(struct l2fwd_crypto_options *options)
1290 printf("\n---- Authentication information ---\n");
1291 printf("Algorithm: %s\n",
1292 supported_auth_algo[options->auth_xform.auth.algo]);
1293 rte_hexdump(stdout, "Auth key:",
1294 options->auth_xform.auth.key.data,
1295 options->auth_xform.auth.key.length);
1296 rte_hexdump(stdout, "AAD:", options->aad.data, options->aad.length);
1300 l2fwd_crypto_options_print(struct l2fwd_crypto_options *options)
1302 char string_cipher_op[MAX_STR_LEN];
1303 char string_auth_op[MAX_STR_LEN];
1305 if (options->cipher_xform.cipher.op == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
1306 strcpy(string_cipher_op, "Encrypt");
1308 strcpy(string_cipher_op, "Decrypt");
1310 if (options->auth_xform.auth.op == RTE_CRYPTO_AUTH_OP_GENERATE)
1311 strcpy(string_auth_op, "Auth generate");
1313 strcpy(string_auth_op, "Auth verify");
1315 printf("Options:-\nn");
1316 printf("portmask: %x\n", options->portmask);
1317 printf("ports per lcore: %u\n", options->nb_ports_per_lcore);
1318 printf("refresh period : %u\n", options->refresh_period);
1319 printf("single lcore mode: %s\n",
1320 options->single_lcore ? "enabled" : "disabled");
1321 printf("stats_printing: %s\n",
1322 options->refresh_period == 0 ? "disabled" : "enabled");
1324 printf("sessionless crypto: %s\n",
1325 options->sessionless ? "enabled" : "disabled");
1327 if (options->ckey_param && (options->ckey_random_size != -1))
1328 printf("Cipher key already parsed, ignoring size of random key\n");
1330 if (options->akey_param && (options->akey_random_size != -1))
1331 printf("Auth key already parsed, ignoring size of random key\n");
1333 if (options->iv_param && (options->iv_random_size != -1))
1334 printf("IV already parsed, ignoring size of random IV\n");
1336 if (options->aad_param && (options->aad_random_size != -1))
1337 printf("AAD already parsed, ignoring size of random AAD\n");
1339 printf("\nCrypto chain: ");
1340 switch (options->xform_chain) {
1341 case L2FWD_CRYPTO_CIPHER_HASH:
1342 printf("Input --> %s --> %s --> Output\n",
1343 string_cipher_op, string_auth_op);
1344 display_cipher_info(options);
1345 display_auth_info(options);
1347 case L2FWD_CRYPTO_HASH_CIPHER:
1348 printf("Input --> %s --> %s --> Output\n",
1349 string_auth_op, string_cipher_op);
1350 display_cipher_info(options);
1351 display_auth_info(options);
1353 case L2FWD_CRYPTO_HASH_ONLY:
1354 printf("Input --> %s --> Output\n", string_auth_op);
1355 display_auth_info(options);
1357 case L2FWD_CRYPTO_CIPHER_ONLY:
1358 printf("Input --> %s --> Output\n", string_cipher_op);
1359 display_cipher_info(options);
1364 /* Parse the argument given in the command line of the application */
1366 l2fwd_crypto_parse_args(struct l2fwd_crypto_options *options,
1367 int argc, char **argv)
1369 int opt, retval, option_index;
1370 char **argvopt = argv, *prgname = argv[0];
1372 static struct option lgopts[] = {
1373 { "sessionless", no_argument, 0, 0 },
1375 { "cdev_type", required_argument, 0, 0 },
1376 { "chain", required_argument, 0, 0 },
1378 { "cipher_algo", required_argument, 0, 0 },
1379 { "cipher_op", required_argument, 0, 0 },
1380 { "cipher_key", required_argument, 0, 0 },
1381 { "cipher_key_random_size", required_argument, 0, 0 },
1383 { "auth_algo", required_argument, 0, 0 },
1384 { "auth_op", required_argument, 0, 0 },
1385 { "auth_key", required_argument, 0, 0 },
1386 { "auth_key_random_size", required_argument, 0, 0 },
1388 { "iv", required_argument, 0, 0 },
1389 { "iv_random_size", required_argument, 0, 0 },
1390 { "aad", required_argument, 0, 0 },
1391 { "aad_random_size", required_argument, 0, 0 },
1392 { "digest_size", required_argument, 0, 0 },
1394 { "sessionless", no_argument, 0, 0 },
1399 l2fwd_crypto_default_options(options);
1401 while ((opt = getopt_long(argc, argvopt, "p:q:sT:", lgopts,
1402 &option_index)) != EOF) {
1406 retval = l2fwd_crypto_parse_args_long_options(options,
1407 lgopts, option_index);
1409 l2fwd_crypto_usage(prgname);
1416 retval = l2fwd_crypto_parse_portmask(options, optarg);
1418 l2fwd_crypto_usage(prgname);
1425 retval = l2fwd_crypto_parse_nqueue(options, optarg);
1427 l2fwd_crypto_usage(prgname);
1434 options->single_lcore = 1;
1440 retval = l2fwd_crypto_parse_timer_period(options,
1443 l2fwd_crypto_usage(prgname);
1449 l2fwd_crypto_usage(prgname);
1456 argv[optind-1] = prgname;
1459 optind = 0; /* reset getopt lib */
1464 /* Check the link status of all ports in up to 9s, and print them finally */
1466 check_all_ports_link_status(uint8_t port_num, uint32_t port_mask)
1468 #define CHECK_INTERVAL 100 /* 100ms */
1469 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
1470 uint8_t portid, count, all_ports_up, print_flag = 0;
1471 struct rte_eth_link link;
1473 printf("\nChecking link status");
1475 for (count = 0; count <= MAX_CHECK_TIME; count++) {
1477 for (portid = 0; portid < port_num; portid++) {
1478 if ((port_mask & (1 << portid)) == 0)
1480 memset(&link, 0, sizeof(link));
1481 rte_eth_link_get_nowait(portid, &link);
1482 /* print link status if flag set */
1483 if (print_flag == 1) {
1484 if (link.link_status)
1485 printf("Port %d Link Up - speed %u "
1486 "Mbps - %s\n", (uint8_t)portid,
1487 (unsigned)link.link_speed,
1488 (link.link_duplex == ETH_LINK_FULL_DUPLEX) ?
1489 ("full-duplex") : ("half-duplex\n"));
1491 printf("Port %d Link Down\n",
1495 /* clear all_ports_up flag if any link down */
1496 if (link.link_status == ETH_LINK_DOWN) {
1501 /* after finally printing all link status, get out */
1502 if (print_flag == 1)
1505 if (all_ports_up == 0) {
1508 rte_delay_ms(CHECK_INTERVAL);
1511 /* set the print_flag if all ports up or timeout */
1512 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
1519 /* Check if device has to be HW/SW or any */
1521 check_type(struct l2fwd_crypto_options *options, struct rte_cryptodev_info *dev_info)
1523 if (options->type == CDEV_TYPE_HW &&
1524 (dev_info->feature_flags & RTE_CRYPTODEV_FF_HW_ACCELERATED))
1526 if (options->type == CDEV_TYPE_SW &&
1527 !(dev_info->feature_flags & RTE_CRYPTODEV_FF_HW_ACCELERATED))
1529 if (options->type == CDEV_TYPE_ANY)
1536 check_supported_size(uint16_t length, uint16_t min, uint16_t max,
1542 if (increment == 0) {
1549 /* Range of values */
1550 for (supp_size = min; supp_size <= max; supp_size += increment) {
1551 if (length == supp_size)
1558 initialize_cryptodevs(struct l2fwd_crypto_options *options, unsigned nb_ports,
1559 uint8_t *enabled_cdevs)
1561 unsigned i, cdev_id, cdev_count, enabled_cdev_count = 0;
1562 const struct rte_cryptodev_capabilities *cap;
1563 enum rte_crypto_auth_algorithm cap_auth_algo;
1564 enum rte_crypto_auth_algorithm opt_auth_algo;
1565 enum rte_crypto_cipher_algorithm cap_cipher_algo;
1566 enum rte_crypto_cipher_algorithm opt_cipher_algo;
1569 cdev_count = rte_cryptodev_count();
1570 if (cdev_count == 0) {
1571 printf("No crypto devices available\n");
1575 for (cdev_id = 0; cdev_id < cdev_count && enabled_cdev_count < nb_ports;
1577 struct rte_cryptodev_qp_conf qp_conf;
1578 struct rte_cryptodev_info dev_info;
1580 struct rte_cryptodev_config conf = {
1581 .nb_queue_pairs = 1,
1582 .socket_id = SOCKET_ID_ANY,
1589 rte_cryptodev_info_get(cdev_id, &dev_info);
1591 /* Set cipher parameters */
1592 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH ||
1593 options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER ||
1594 options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
1595 /* Check if device supports cipher algo */
1597 opt_cipher_algo = options->cipher_xform.cipher.algo;
1598 cap = &dev_info.capabilities[i];
1599 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1600 cap_cipher_algo = cap->sym.cipher.algo;
1601 if (cap->sym.xform_type ==
1602 RTE_CRYPTO_SYM_XFORM_CIPHER) {
1603 if (cap_cipher_algo == opt_cipher_algo) {
1604 if (check_type(options, &dev_info) == 0)
1608 cap = &dev_info.capabilities[++i];
1611 if (cap->op == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1612 printf("Algorithm %s not supported by cryptodev %u"
1613 " or device not of preferred type (%s)\n",
1614 supported_cipher_algo[opt_cipher_algo],
1616 options->string_type);
1620 options->block_size = cap->sym.cipher.block_size;
1622 * Check if length of provided IV is supported
1623 * by the algorithm chosen.
1625 if (options->iv_param) {
1626 if (check_supported_size(options->iv.length,
1627 cap->sym.cipher.iv_size.min,
1628 cap->sym.cipher.iv_size.max,
1629 cap->sym.cipher.iv_size.increment)
1631 printf("Unsupported IV length\n");
1635 * Check if length of IV to be randomly generated
1636 * is supported by the algorithm chosen.
1638 } else if (options->iv_random_size != -1) {
1639 if (check_supported_size(options->iv_random_size,
1640 cap->sym.cipher.iv_size.min,
1641 cap->sym.cipher.iv_size.max,
1642 cap->sym.cipher.iv_size.increment)
1644 printf("Unsupported IV length\n");
1647 options->iv.length = options->iv_random_size;
1648 /* No size provided, use minimum size. */
1650 options->iv.length = cap->sym.cipher.iv_size.min;
1653 * Check if length of provided cipher key is supported
1654 * by the algorithm chosen.
1656 if (options->ckey_param) {
1657 if (check_supported_size(
1658 options->cipher_xform.cipher.key.length,
1659 cap->sym.cipher.key_size.min,
1660 cap->sym.cipher.key_size.max,
1661 cap->sym.cipher.key_size.increment)
1663 printf("Unsupported cipher key length\n");
1667 * Check if length of the cipher key to be randomly generated
1668 * is supported by the algorithm chosen.
1670 } else if (options->ckey_random_size != -1) {
1671 if (check_supported_size(options->ckey_random_size,
1672 cap->sym.cipher.key_size.min,
1673 cap->sym.cipher.key_size.max,
1674 cap->sym.cipher.key_size.increment)
1676 printf("Unsupported cipher key length\n");
1679 options->cipher_xform.cipher.key.length =
1680 options->ckey_random_size;
1681 /* No size provided, use minimum size. */
1683 options->cipher_xform.cipher.key.length =
1684 cap->sym.cipher.key_size.min;
1686 if (!options->ckey_param)
1687 generate_random_key(
1688 options->cipher_xform.cipher.key.data,
1689 options->cipher_xform.cipher.key.length);
1693 /* Set auth parameters */
1694 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH ||
1695 options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER ||
1696 options->xform_chain == L2FWD_CRYPTO_HASH_ONLY) {
1697 /* Check if device supports auth algo */
1699 opt_auth_algo = options->auth_xform.auth.algo;
1700 cap = &dev_info.capabilities[i];
1701 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1702 cap_auth_algo = cap->sym.auth.algo;
1703 if ((cap->sym.xform_type == RTE_CRYPTO_SYM_XFORM_AUTH) &&
1704 (cap_auth_algo == opt_auth_algo) &&
1705 (check_type(options, &dev_info) == 0)) {
1708 cap = &dev_info.capabilities[++i];
1711 if (cap->op == RTE_CRYPTO_OP_TYPE_UNDEFINED) {
1712 printf("Algorithm %s not supported by cryptodev %u"
1713 " or device not of preferred type (%s)\n",
1714 supported_auth_algo[opt_auth_algo],
1716 options->string_type);
1721 * Check if length of provided AAD is supported
1722 * by the algorithm chosen.
1724 if (options->aad_param) {
1725 if (check_supported_size(options->aad.length,
1726 cap->sym.auth.aad_size.min,
1727 cap->sym.auth.aad_size.max,
1728 cap->sym.auth.aad_size.increment)
1730 printf("Unsupported AAD length\n");
1734 * Check if length of AAD to be randomly generated
1735 * is supported by the algorithm chosen.
1737 } else if (options->aad_random_size != -1) {
1738 if (check_supported_size(options->aad_random_size,
1739 cap->sym.auth.aad_size.min,
1740 cap->sym.auth.aad_size.max,
1741 cap->sym.auth.aad_size.increment)
1743 printf("Unsupported AAD length\n");
1746 options->aad.length = options->aad_random_size;
1747 /* No size provided, use minimum size. */
1749 options->aad.length = cap->sym.auth.aad_size.min;
1751 options->auth_xform.auth.add_auth_data_length =
1752 options->aad.length;
1755 * Check if length of provided auth key is supported
1756 * by the algorithm chosen.
1758 if (options->akey_param) {
1759 if (check_supported_size(
1760 options->auth_xform.auth.key.length,
1761 cap->sym.auth.key_size.min,
1762 cap->sym.auth.key_size.max,
1763 cap->sym.auth.key_size.increment)
1765 printf("Unsupported auth key length\n");
1769 * Check if length of the auth key to be randomly generated
1770 * is supported by the algorithm chosen.
1772 } else if (options->akey_random_size != -1) {
1773 if (check_supported_size(options->akey_random_size,
1774 cap->sym.auth.key_size.min,
1775 cap->sym.auth.key_size.max,
1776 cap->sym.auth.key_size.increment)
1778 printf("Unsupported auth key length\n");
1781 options->auth_xform.auth.key.length =
1782 options->akey_random_size;
1783 /* No size provided, use minimum size. */
1785 options->auth_xform.auth.key.length =
1786 cap->sym.auth.key_size.min;
1788 if (!options->akey_param)
1789 generate_random_key(
1790 options->auth_xform.auth.key.data,
1791 options->auth_xform.auth.key.length);
1793 /* Check if digest size is supported by the algorithm. */
1794 if (options->digest_size != -1) {
1795 if (check_supported_size(options->digest_size,
1796 cap->sym.auth.digest_size.min,
1797 cap->sym.auth.digest_size.max,
1798 cap->sym.auth.digest_size.increment)
1800 printf("Unsupported digest length\n");
1803 options->auth_xform.auth.digest_length =
1804 options->digest_size;
1805 /* No size provided, use minimum size. */
1807 options->auth_xform.auth.digest_length =
1808 cap->sym.auth.digest_size.min;
1811 retval = rte_cryptodev_configure(cdev_id, &conf);
1813 printf("Failed to configure cryptodev %u", cdev_id);
1817 qp_conf.nb_descriptors = 2048;
1819 retval = rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf,
1822 printf("Failed to setup queue pair %u on cryptodev %u",
1827 retval = rte_cryptodev_start(cdev_id);
1829 printf("Failed to start device %u: error %d\n",
1834 l2fwd_enabled_crypto_mask |= (((uint64_t)1) << cdev_id);
1836 enabled_cdevs[cdev_id] = 1;
1837 enabled_cdev_count++;
1840 return enabled_cdev_count;
1844 initialize_ports(struct l2fwd_crypto_options *options)
1846 uint8_t last_portid, portid;
1847 unsigned enabled_portcount = 0;
1848 unsigned nb_ports = rte_eth_dev_count();
1850 if (nb_ports == 0) {
1851 printf("No Ethernet ports - bye\n");
1855 /* Reset l2fwd_dst_ports */
1856 for (portid = 0; portid < RTE_MAX_ETHPORTS; portid++)
1857 l2fwd_dst_ports[portid] = 0;
1859 for (last_portid = 0, portid = 0; portid < nb_ports; portid++) {
1862 /* Skip ports that are not enabled */
1863 if ((options->portmask & (1 << portid)) == 0)
1867 printf("Initializing port %u... ", (unsigned) portid);
1869 retval = rte_eth_dev_configure(portid, 1, 1, &port_conf);
1871 printf("Cannot configure device: err=%d, port=%u\n",
1872 retval, (unsigned) portid);
1876 /* init one RX queue */
1878 retval = rte_eth_rx_queue_setup(portid, 0, nb_rxd,
1879 rte_eth_dev_socket_id(portid),
1880 NULL, l2fwd_pktmbuf_pool);
1882 printf("rte_eth_rx_queue_setup:err=%d, port=%u\n",
1883 retval, (unsigned) portid);
1887 /* init one TX queue on each port */
1889 retval = rte_eth_tx_queue_setup(portid, 0, nb_txd,
1890 rte_eth_dev_socket_id(portid),
1893 printf("rte_eth_tx_queue_setup:err=%d, port=%u\n",
1894 retval, (unsigned) portid);
1900 retval = rte_eth_dev_start(portid);
1902 printf("rte_eth_dev_start:err=%d, port=%u\n",
1903 retval, (unsigned) portid);
1907 rte_eth_promiscuous_enable(portid);
1909 rte_eth_macaddr_get(portid, &l2fwd_ports_eth_addr[portid]);
1911 printf("Port %u, MAC address: %02X:%02X:%02X:%02X:%02X:%02X\n\n",
1913 l2fwd_ports_eth_addr[portid].addr_bytes[0],
1914 l2fwd_ports_eth_addr[portid].addr_bytes[1],
1915 l2fwd_ports_eth_addr[portid].addr_bytes[2],
1916 l2fwd_ports_eth_addr[portid].addr_bytes[3],
1917 l2fwd_ports_eth_addr[portid].addr_bytes[4],
1918 l2fwd_ports_eth_addr[portid].addr_bytes[5]);
1920 /* initialize port stats */
1921 memset(&port_statistics, 0, sizeof(port_statistics));
1923 /* Setup port forwarding table */
1924 if (enabled_portcount % 2) {
1925 l2fwd_dst_ports[portid] = last_portid;
1926 l2fwd_dst_ports[last_portid] = portid;
1928 last_portid = portid;
1931 l2fwd_enabled_port_mask |= (1 << portid);
1932 enabled_portcount++;
1935 if (enabled_portcount == 1) {
1936 l2fwd_dst_ports[last_portid] = last_portid;
1937 } else if (enabled_portcount % 2) {
1938 printf("odd number of ports in portmask- bye\n");
1942 check_all_ports_link_status(nb_ports, l2fwd_enabled_port_mask);
1944 return enabled_portcount;
1948 reserve_key_memory(struct l2fwd_crypto_options *options)
1950 options->cipher_xform.cipher.key.data = rte_malloc("crypto key",
1952 if (options->cipher_xform.cipher.key.data == NULL)
1953 rte_exit(EXIT_FAILURE, "Failed to allocate memory for cipher key");
1956 options->auth_xform.auth.key.data = rte_malloc("auth key",
1958 if (options->auth_xform.auth.key.data == NULL)
1959 rte_exit(EXIT_FAILURE, "Failed to allocate memory for auth key");
1961 options->iv.data = rte_malloc("iv", MAX_KEY_SIZE, 0);
1962 if (options->iv.data == NULL)
1963 rte_exit(EXIT_FAILURE, "Failed to allocate memory for IV");
1964 options->iv.phys_addr = rte_malloc_virt2phy(options->iv.data);
1966 options->aad.data = rte_malloc("aad", MAX_KEY_SIZE, 0);
1967 if (options->aad.data == NULL)
1968 rte_exit(EXIT_FAILURE, "Failed to allocate memory for AAD");
1969 options->aad.phys_addr = rte_malloc_virt2phy(options->aad.data);
1973 main(int argc, char **argv)
1975 struct lcore_queue_conf *qconf;
1976 struct l2fwd_crypto_options options;
1978 uint8_t nb_ports, nb_cryptodevs, portid, cdev_id;
1979 unsigned lcore_id, rx_lcore_id;
1980 int ret, enabled_cdevcount, enabled_portcount;
1981 uint8_t enabled_cdevs[RTE_CRYPTO_MAX_DEVS] = {0};
1984 ret = rte_eal_init(argc, argv);
1986 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
1990 /* reserve memory for Cipher/Auth key and IV */
1991 reserve_key_memory(&options);
1993 /* fill out the supported algorithm tables */
1994 fill_supported_algorithm_tables();
1996 /* parse application arguments (after the EAL ones) */
1997 ret = l2fwd_crypto_parse_args(&options, argc, argv);
1999 rte_exit(EXIT_FAILURE, "Invalid L2FWD-CRYPTO arguments\n");
2001 /* create the mbuf pool */
2002 l2fwd_pktmbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", NB_MBUF, 512,
2003 sizeof(struct rte_crypto_op),
2004 RTE_MBUF_DEFAULT_BUF_SIZE, rte_socket_id());
2005 if (l2fwd_pktmbuf_pool == NULL)
2006 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
2008 /* create crypto op pool */
2009 l2fwd_crypto_op_pool = rte_crypto_op_pool_create("crypto_op_pool",
2010 RTE_CRYPTO_OP_TYPE_SYMMETRIC, NB_MBUF, 128, 0,
2012 if (l2fwd_crypto_op_pool == NULL)
2013 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
2015 /* Enable Ethernet ports */
2016 enabled_portcount = initialize_ports(&options);
2017 if (enabled_portcount < 1)
2018 rte_exit(EXIT_FAILURE, "Failed to initial Ethernet ports\n");
2020 nb_ports = rte_eth_dev_count();
2021 /* Initialize the port/queue configuration of each logical core */
2022 for (rx_lcore_id = 0, qconf = NULL, portid = 0;
2023 portid < nb_ports; portid++) {
2025 /* skip ports that are not enabled */
2026 if ((options.portmask & (1 << portid)) == 0)
2029 if (options.single_lcore && qconf == NULL) {
2030 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
2032 if (rx_lcore_id >= RTE_MAX_LCORE)
2033 rte_exit(EXIT_FAILURE,
2034 "Not enough cores\n");
2036 } else if (!options.single_lcore) {
2037 /* get the lcore_id for this port */
2038 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
2039 lcore_queue_conf[rx_lcore_id].nb_rx_ports ==
2040 options.nb_ports_per_lcore) {
2042 if (rx_lcore_id >= RTE_MAX_LCORE)
2043 rte_exit(EXIT_FAILURE,
2044 "Not enough cores\n");
2048 /* Assigned a new logical core in the loop above. */
2049 if (qconf != &lcore_queue_conf[rx_lcore_id])
2050 qconf = &lcore_queue_conf[rx_lcore_id];
2052 qconf->rx_port_list[qconf->nb_rx_ports] = portid;
2053 qconf->nb_rx_ports++;
2055 printf("Lcore %u: RX port %u\n", rx_lcore_id, (unsigned)portid);
2058 /* Enable Crypto devices */
2059 enabled_cdevcount = initialize_cryptodevs(&options, enabled_portcount,
2061 if (enabled_cdevcount < 0)
2062 rte_exit(EXIT_FAILURE, "Failed to initialize crypto devices\n");
2064 if (enabled_cdevcount < enabled_portcount)
2065 rte_exit(EXIT_FAILURE, "Number of capable crypto devices (%d) "
2066 "has to be more or equal to number of ports (%d)\n",
2067 enabled_cdevcount, enabled_portcount);
2069 nb_cryptodevs = rte_cryptodev_count();
2071 /* Initialize the port/cryptodev configuration of each logical core */
2072 for (rx_lcore_id = 0, qconf = NULL, cdev_id = 0;
2073 cdev_id < nb_cryptodevs && enabled_cdevcount;
2075 /* Crypto op not supported by crypto device */
2076 if (!enabled_cdevs[cdev_id])
2079 if (options.single_lcore && qconf == NULL) {
2080 while (rte_lcore_is_enabled(rx_lcore_id) == 0) {
2082 if (rx_lcore_id >= RTE_MAX_LCORE)
2083 rte_exit(EXIT_FAILURE,
2084 "Not enough cores\n");
2086 } else if (!options.single_lcore) {
2087 /* get the lcore_id for this port */
2088 while (rte_lcore_is_enabled(rx_lcore_id) == 0 ||
2089 lcore_queue_conf[rx_lcore_id].nb_crypto_devs ==
2090 options.nb_ports_per_lcore) {
2092 if (rx_lcore_id >= RTE_MAX_LCORE)
2093 rte_exit(EXIT_FAILURE,
2094 "Not enough cores\n");
2098 /* Assigned a new logical core in the loop above. */
2099 if (qconf != &lcore_queue_conf[rx_lcore_id])
2100 qconf = &lcore_queue_conf[rx_lcore_id];
2102 qconf->cryptodev_list[qconf->nb_crypto_devs] = cdev_id;
2103 qconf->nb_crypto_devs++;
2105 enabled_cdevcount--;
2107 printf("Lcore %u: cryptodev %u\n", rx_lcore_id,
2111 /* launch per-lcore init on every lcore */
2112 rte_eal_mp_remote_launch(l2fwd_launch_one_lcore, (void *)&options,
2114 RTE_LCORE_FOREACH_SLAVE(lcore_id) {
2115 if (rte_eal_wait_lcore(lcore_id) < 0)