1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016 Intel Corporation
10 #include <sys/types.h>
11 #include <netinet/in.h>
12 #include <netinet/ip.h>
13 #include <netinet/ip6.h>
15 #include <sys/queue.h>
21 #include <rte_common.h>
22 #include <rte_bitmap.h>
23 #include <rte_byteorder.h>
26 #include <rte_launch.h>
27 #include <rte_cycles.h>
28 #include <rte_prefetch.h>
29 #include <rte_lcore.h>
30 #include <rte_per_lcore.h>
31 #include <rte_branch_prediction.h>
32 #include <rte_interrupts.h>
33 #include <rte_random.h>
34 #include <rte_debug.h>
35 #include <rte_ether.h>
36 #include <rte_ethdev.h>
37 #include <rte_mempool.h>
43 #include <rte_jhash.h>
44 #include <rte_cryptodev.h>
45 #include <rte_security.h>
46 #include <rte_eventdev.h>
48 #include <rte_ip_frag.h>
49 #include <rte_alarm.h>
50 #include <rte_telemetry.h>
52 #include "event_helper.h"
55 #include "ipsec_worker.h"
59 volatile bool force_quit;
61 #define MAX_JUMBO_PKT_LEN 9600
63 #define MEMPOOL_CACHE_SIZE 256
65 #define CDEV_QUEUE_DESC 2048
66 #define CDEV_MAP_ENTRIES 16384
67 #define CDEV_MP_CACHE_SZ 64
68 #define CDEV_MP_CACHE_MULTIPLIER 1.5 /* from rte_mempool.c */
69 #define MAX_QUEUE_PAIRS 1
71 #define BURST_TX_DRAIN_US 100 /* TX drain every ~100us */
73 #define MAX_LCORE_PARAMS 1024
76 * Configurable number of RX/TX ring descriptors
78 #define IPSEC_SECGW_RX_DESC_DEFAULT 1024
79 #define IPSEC_SECGW_TX_DESC_DEFAULT 1024
80 static uint16_t nb_rxd = IPSEC_SECGW_RX_DESC_DEFAULT;
81 static uint16_t nb_txd = IPSEC_SECGW_TX_DESC_DEFAULT;
83 #define ETHADDR_TO_UINT64(addr) __BYTES_TO_UINT64( \
84 (addr)->addr_bytes[0], (addr)->addr_bytes[1], \
85 (addr)->addr_bytes[2], (addr)->addr_bytes[3], \
86 (addr)->addr_bytes[4], (addr)->addr_bytes[5], \
89 #define FRAG_TBL_BUCKET_ENTRIES 4
90 #define MAX_FRAG_TTL_NS (10LL * NS_PER_S)
92 #define MTU_TO_FRAMELEN(x) ((x) + RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN)
94 struct ethaddr_info ethaddr_tbl[RTE_MAX_ETHPORTS] = {
95 { 0, ETHADDR(0x00, 0x16, 0x3e, 0x7e, 0x94, 0x9a) },
96 { 0, ETHADDR(0x00, 0x16, 0x3e, 0x22, 0xa1, 0xd9) },
97 { 0, ETHADDR(0x00, 0x16, 0x3e, 0x08, 0x69, 0x26) },
98 { 0, ETHADDR(0x00, 0x16, 0x3e, 0x49, 0x9e, 0xdd) }
101 struct flow_info flow_info_tbl[RTE_MAX_ETHPORTS];
103 #define CMD_LINE_OPT_CONFIG "config"
104 #define CMD_LINE_OPT_SINGLE_SA "single-sa"
105 #define CMD_LINE_OPT_CRYPTODEV_MASK "cryptodev_mask"
106 #define CMD_LINE_OPT_TRANSFER_MODE "transfer-mode"
107 #define CMD_LINE_OPT_SCHEDULE_TYPE "event-schedule-type"
108 #define CMD_LINE_OPT_RX_OFFLOAD "rxoffload"
109 #define CMD_LINE_OPT_TX_OFFLOAD "txoffload"
110 #define CMD_LINE_OPT_REASSEMBLE "reassemble"
111 #define CMD_LINE_OPT_MTU "mtu"
112 #define CMD_LINE_OPT_FRAG_TTL "frag-ttl"
113 #define CMD_LINE_OPT_EVENT_VECTOR "event-vector"
114 #define CMD_LINE_OPT_VECTOR_SIZE "vector-size"
115 #define CMD_LINE_OPT_VECTOR_TIMEOUT "vector-tmo"
116 #define CMD_LINE_OPT_VECTOR_POOL_SZ "vector-pool-sz"
117 #define CMD_LINE_OPT_PER_PORT_POOL "per-port-pool"
119 #define CMD_LINE_ARG_EVENT "event"
120 #define CMD_LINE_ARG_POLL "poll"
121 #define CMD_LINE_ARG_ORDERED "ordered"
122 #define CMD_LINE_ARG_ATOMIC "atomic"
123 #define CMD_LINE_ARG_PARALLEL "parallel"
126 /* long options mapped to a short option */
128 /* first long only option value must be >= 256, so that we won't
129 * conflict with short options
131 CMD_LINE_OPT_MIN_NUM = 256,
132 CMD_LINE_OPT_CONFIG_NUM,
133 CMD_LINE_OPT_SINGLE_SA_NUM,
134 CMD_LINE_OPT_CRYPTODEV_MASK_NUM,
135 CMD_LINE_OPT_TRANSFER_MODE_NUM,
136 CMD_LINE_OPT_SCHEDULE_TYPE_NUM,
137 CMD_LINE_OPT_RX_OFFLOAD_NUM,
138 CMD_LINE_OPT_TX_OFFLOAD_NUM,
139 CMD_LINE_OPT_REASSEMBLE_NUM,
140 CMD_LINE_OPT_MTU_NUM,
141 CMD_LINE_OPT_FRAG_TTL_NUM,
142 CMD_LINE_OPT_EVENT_VECTOR_NUM,
143 CMD_LINE_OPT_VECTOR_SIZE_NUM,
144 CMD_LINE_OPT_VECTOR_TIMEOUT_NUM,
145 CMD_LINE_OPT_VECTOR_POOL_SZ_NUM,
146 CMD_LINE_OPT_PER_PORT_POOL_NUM,
149 static const struct option lgopts[] = {
150 {CMD_LINE_OPT_CONFIG, 1, 0, CMD_LINE_OPT_CONFIG_NUM},
151 {CMD_LINE_OPT_SINGLE_SA, 1, 0, CMD_LINE_OPT_SINGLE_SA_NUM},
152 {CMD_LINE_OPT_CRYPTODEV_MASK, 1, 0, CMD_LINE_OPT_CRYPTODEV_MASK_NUM},
153 {CMD_LINE_OPT_TRANSFER_MODE, 1, 0, CMD_LINE_OPT_TRANSFER_MODE_NUM},
154 {CMD_LINE_OPT_SCHEDULE_TYPE, 1, 0, CMD_LINE_OPT_SCHEDULE_TYPE_NUM},
155 {CMD_LINE_OPT_RX_OFFLOAD, 1, 0, CMD_LINE_OPT_RX_OFFLOAD_NUM},
156 {CMD_LINE_OPT_TX_OFFLOAD, 1, 0, CMD_LINE_OPT_TX_OFFLOAD_NUM},
157 {CMD_LINE_OPT_REASSEMBLE, 1, 0, CMD_LINE_OPT_REASSEMBLE_NUM},
158 {CMD_LINE_OPT_MTU, 1, 0, CMD_LINE_OPT_MTU_NUM},
159 {CMD_LINE_OPT_FRAG_TTL, 1, 0, CMD_LINE_OPT_FRAG_TTL_NUM},
160 {CMD_LINE_OPT_EVENT_VECTOR, 0, 0, CMD_LINE_OPT_EVENT_VECTOR_NUM},
161 {CMD_LINE_OPT_VECTOR_SIZE, 1, 0, CMD_LINE_OPT_VECTOR_SIZE_NUM},
162 {CMD_LINE_OPT_VECTOR_TIMEOUT, 1, 0, CMD_LINE_OPT_VECTOR_TIMEOUT_NUM},
163 {CMD_LINE_OPT_VECTOR_POOL_SZ, 1, 0, CMD_LINE_OPT_VECTOR_POOL_SZ_NUM},
164 {CMD_LINE_OPT_PER_PORT_POOL, 0, 0, CMD_LINE_OPT_PER_PORT_POOL_NUM},
168 uint32_t unprotected_port_mask;
169 uint32_t single_sa_idx;
170 /* mask of enabled ports */
171 static uint32_t enabled_port_mask;
172 static uint64_t enabled_cryptodev_mask = UINT64_MAX;
173 static int32_t promiscuous_on = 1;
174 static int32_t numa_on = 1; /**< NUMA is enabled by default. */
175 static uint32_t nb_lcores;
176 static uint32_t single_sa;
177 uint32_t nb_bufs_in_pool;
180 * RX/TX HW offload capabilities to enable/use on ethernet ports.
181 * By default all capabilities are enabled.
183 static uint64_t dev_rx_offload = UINT64_MAX;
184 static uint64_t dev_tx_offload = UINT64_MAX;
187 * global values that determine multi-seg policy
189 uint32_t frag_tbl_sz;
190 static uint32_t frame_buf_size = RTE_MBUF_DEFAULT_BUF_SIZE;
191 uint32_t mtu_size = RTE_ETHER_MTU;
192 static uint64_t frag_ttl_ns = MAX_FRAG_TTL_NS;
193 static uint32_t stats_interval;
195 /* application wide librte_ipsec/SA parameters */
196 struct app_sa_prm app_sa_prm = {
198 .cache_sz = SA_CACHE_SZ,
201 static const char *cfgfile;
203 struct lcore_params {
207 } __rte_cache_aligned;
209 static struct lcore_params lcore_params_array[MAX_LCORE_PARAMS];
211 static struct lcore_params *lcore_params;
212 static uint16_t nb_lcore_params;
214 static struct rte_hash *cdev_map_in;
215 static struct rte_hash *cdev_map_out;
217 struct lcore_conf lcore_conf[RTE_MAX_LCORE];
219 static struct rte_eth_conf port_conf = {
221 .mq_mode = RTE_ETH_MQ_RX_RSS,
223 .offloads = RTE_ETH_RX_OFFLOAD_CHECKSUM,
228 .rss_hf = RTE_ETH_RSS_IP | RTE_ETH_RSS_UDP |
229 RTE_ETH_RSS_TCP | RTE_ETH_RSS_SCTP,
233 .mq_mode = RTE_ETH_MQ_TX_NONE,
237 struct socket_ctx socket_ctx[NB_SOCKETS];
242 * Determine is multi-segment support required:
243 * - either frame buffer size is smaller then mtu
244 * - or reassemble support is requested
247 multi_seg_required(void)
249 return (MTU_TO_FRAMELEN(mtu_size) + RTE_PKTMBUF_HEADROOM >
250 frame_buf_size || frag_tbl_sz != 0);
254 struct ipsec_core_statistics core_statistics[RTE_MAX_LCORE];
256 /* Print out statistics on packet distribution */
258 print_stats_cb(__rte_unused void *param)
260 uint64_t total_packets_dropped, total_packets_tx, total_packets_rx;
261 float burst_percent, rx_per_call, tx_per_call;
264 total_packets_dropped = 0;
265 total_packets_tx = 0;
266 total_packets_rx = 0;
268 const char clr[] = { 27, '[', '2', 'J', '\0' };
269 const char topLeft[] = { 27, '[', '1', ';', '1', 'H', '\0' };
271 /* Clear screen and move to top left */
272 printf("%s%s", clr, topLeft);
274 printf("\nCore statistics ====================================");
276 for (coreid = 0; coreid < RTE_MAX_LCORE; coreid++) {
277 /* skip disabled cores */
278 if (rte_lcore_is_enabled(coreid) == 0)
280 burst_percent = (float)(core_statistics[coreid].burst_rx * 100)/
281 core_statistics[coreid].rx;
282 rx_per_call = (float)(core_statistics[coreid].rx)/
283 core_statistics[coreid].rx_call;
284 tx_per_call = (float)(core_statistics[coreid].tx)/
285 core_statistics[coreid].tx_call;
286 printf("\nStatistics for core %u ------------------------------"
287 "\nPackets received: %20"PRIu64
288 "\nPackets sent: %24"PRIu64
289 "\nPackets dropped: %21"PRIu64
290 "\nBurst percent: %23.2f"
291 "\nPackets per Rx call: %17.2f"
292 "\nPackets per Tx call: %17.2f",
294 core_statistics[coreid].rx,
295 core_statistics[coreid].tx,
296 core_statistics[coreid].dropped,
301 total_packets_dropped += core_statistics[coreid].dropped;
302 total_packets_tx += core_statistics[coreid].tx;
303 total_packets_rx += core_statistics[coreid].rx;
305 printf("\nAggregate statistics ==============================="
306 "\nTotal packets received: %14"PRIu64
307 "\nTotal packets sent: %18"PRIu64
308 "\nTotal packets dropped: %15"PRIu64,
311 total_packets_dropped);
312 printf("\n====================================================\n");
314 rte_eal_alarm_set(stats_interval * US_PER_S, print_stats_cb, NULL);
318 split46_traffic(struct ipsec_traffic *trf, struct rte_mbuf *mb[], uint32_t num)
327 for (i = 0; i < num; i++) {
330 ip = rte_pktmbuf_mtod(m, struct ip *);
332 if (ip->ip_v == IPVERSION) {
333 trf->ip4.pkts[n4] = m;
334 trf->ip4.data[n4] = rte_pktmbuf_mtod_offset(m,
335 uint8_t *, offsetof(struct ip, ip_p));
337 } else if (ip->ip_v == IP6_VERSION) {
338 trf->ip6.pkts[n6] = m;
339 trf->ip6.data[n6] = rte_pktmbuf_mtod_offset(m,
341 offsetof(struct ip6_hdr, ip6_nxt));
353 process_pkts_inbound(struct ipsec_ctx *ipsec_ctx,
354 struct ipsec_traffic *traffic)
356 unsigned int lcoreid = rte_lcore_id();
357 uint16_t nb_pkts_in, n_ip4, n_ip6;
359 n_ip4 = traffic->ip4.num;
360 n_ip6 = traffic->ip6.num;
362 if (app_sa_prm.enable == 0) {
363 nb_pkts_in = ipsec_inbound(ipsec_ctx, traffic->ipsec.pkts,
364 traffic->ipsec.num, MAX_PKT_BURST);
365 split46_traffic(traffic, traffic->ipsec.pkts, nb_pkts_in);
367 inbound_sa_lookup(ipsec_ctx->sa_ctx, traffic->ipsec.pkts,
368 traffic->ipsec.saptr, traffic->ipsec.num);
369 ipsec_process(ipsec_ctx, traffic);
372 inbound_sp_sa(ipsec_ctx->sp4_ctx,
373 ipsec_ctx->sa_ctx, &traffic->ip4, n_ip4,
374 &core_statistics[lcoreid].inbound.spd4);
376 inbound_sp_sa(ipsec_ctx->sp6_ctx,
377 ipsec_ctx->sa_ctx, &traffic->ip6, n_ip6,
378 &core_statistics[lcoreid].inbound.spd6);
382 outbound_spd_lookup(struct sp_ctx *sp,
383 struct traffic_type *ip,
384 struct traffic_type *ipsec,
385 struct ipsec_spd_stats *stats)
388 uint32_t i, j, sa_idx;
390 if (ip->num == 0 || sp == NULL)
393 rte_acl_classify((struct rte_acl_ctx *)sp, ip->data, ip->res,
394 ip->num, DEFAULT_MAX_CATEGORIES);
396 for (i = 0, j = 0; i < ip->num; i++) {
398 sa_idx = ip->res[i] - 1;
400 if (unlikely(ip->res[i] == DISCARD)) {
404 } else if (unlikely(ip->res[i] == BYPASS)) {
409 ipsec->res[ipsec->num] = sa_idx;
410 ipsec->pkts[ipsec->num++] = m;
419 process_pkts_outbound(struct ipsec_ctx *ipsec_ctx,
420 struct ipsec_traffic *traffic)
423 uint16_t idx, nb_pkts_out, i;
424 unsigned int lcoreid = rte_lcore_id();
426 /* Drop any IPsec traffic from protected ports */
427 free_pkts(traffic->ipsec.pkts, traffic->ipsec.num);
429 traffic->ipsec.num = 0;
431 outbound_spd_lookup(ipsec_ctx->sp4_ctx,
432 &traffic->ip4, &traffic->ipsec,
433 &core_statistics[lcoreid].outbound.spd4);
435 outbound_spd_lookup(ipsec_ctx->sp6_ctx,
436 &traffic->ip6, &traffic->ipsec,
437 &core_statistics[lcoreid].outbound.spd6);
439 if (app_sa_prm.enable == 0) {
441 nb_pkts_out = ipsec_outbound(ipsec_ctx, traffic->ipsec.pkts,
442 traffic->ipsec.res, traffic->ipsec.num,
445 for (i = 0; i < nb_pkts_out; i++) {
446 m = traffic->ipsec.pkts[i];
447 struct ip *ip = rte_pktmbuf_mtod(m, struct ip *);
448 if (ip->ip_v == IPVERSION) {
449 idx = traffic->ip4.num++;
450 traffic->ip4.pkts[idx] = m;
452 idx = traffic->ip6.num++;
453 traffic->ip6.pkts[idx] = m;
457 outbound_sa_lookup(ipsec_ctx->sa_ctx, traffic->ipsec.res,
458 traffic->ipsec.saptr, traffic->ipsec.num);
459 ipsec_process(ipsec_ctx, traffic);
464 process_pkts_inbound_nosp(struct ipsec_ctx *ipsec_ctx,
465 struct ipsec_traffic *traffic)
468 uint32_t nb_pkts_in, i, idx;
470 if (app_sa_prm.enable == 0) {
472 nb_pkts_in = ipsec_inbound(ipsec_ctx, traffic->ipsec.pkts,
473 traffic->ipsec.num, MAX_PKT_BURST);
475 for (i = 0; i < nb_pkts_in; i++) {
476 m = traffic->ipsec.pkts[i];
477 struct ip *ip = rte_pktmbuf_mtod(m, struct ip *);
478 if (ip->ip_v == IPVERSION) {
479 idx = traffic->ip4.num++;
480 traffic->ip4.pkts[idx] = m;
482 idx = traffic->ip6.num++;
483 traffic->ip6.pkts[idx] = m;
487 inbound_sa_lookup(ipsec_ctx->sa_ctx, traffic->ipsec.pkts,
488 traffic->ipsec.saptr, traffic->ipsec.num);
489 ipsec_process(ipsec_ctx, traffic);
494 process_pkts_outbound_nosp(struct ipsec_ctx *ipsec_ctx,
495 struct ipsec_traffic *traffic)
498 uint32_t nb_pkts_out, i, n;
501 /* Drop any IPsec traffic from protected ports */
502 free_pkts(traffic->ipsec.pkts, traffic->ipsec.num);
506 for (i = 0; i < traffic->ip4.num; i++) {
507 traffic->ipsec.pkts[n] = traffic->ip4.pkts[i];
508 traffic->ipsec.res[n++] = single_sa_idx;
511 for (i = 0; i < traffic->ip6.num; i++) {
512 traffic->ipsec.pkts[n] = traffic->ip6.pkts[i];
513 traffic->ipsec.res[n++] = single_sa_idx;
516 traffic->ip4.num = 0;
517 traffic->ip6.num = 0;
518 traffic->ipsec.num = n;
520 if (app_sa_prm.enable == 0) {
522 nb_pkts_out = ipsec_outbound(ipsec_ctx, traffic->ipsec.pkts,
523 traffic->ipsec.res, traffic->ipsec.num,
526 /* They all sue the same SA (ip4 or ip6 tunnel) */
527 m = traffic->ipsec.pkts[0];
528 ip = rte_pktmbuf_mtod(m, struct ip *);
529 if (ip->ip_v == IPVERSION) {
530 traffic->ip4.num = nb_pkts_out;
531 for (i = 0; i < nb_pkts_out; i++)
532 traffic->ip4.pkts[i] = traffic->ipsec.pkts[i];
534 traffic->ip6.num = nb_pkts_out;
535 for (i = 0; i < nb_pkts_out; i++)
536 traffic->ip6.pkts[i] = traffic->ipsec.pkts[i];
539 outbound_sa_lookup(ipsec_ctx->sa_ctx, traffic->ipsec.res,
540 traffic->ipsec.saptr, traffic->ipsec.num);
541 ipsec_process(ipsec_ctx, traffic);
546 process_pkts(struct lcore_conf *qconf, struct rte_mbuf **pkts,
547 uint8_t nb_pkts, uint16_t portid)
549 struct ipsec_traffic traffic;
551 prepare_traffic(pkts, &traffic, nb_pkts);
553 if (unlikely(single_sa)) {
554 if (is_unprotected_port(portid))
555 process_pkts_inbound_nosp(&qconf->inbound, &traffic);
557 process_pkts_outbound_nosp(&qconf->outbound, &traffic);
559 if (is_unprotected_port(portid))
560 process_pkts_inbound(&qconf->inbound, &traffic);
562 process_pkts_outbound(&qconf->outbound, &traffic);
565 route4_pkts(qconf->rt4_ctx, traffic.ip4.pkts, traffic.ip4.num);
566 route6_pkts(qconf->rt6_ctx, traffic.ip6.pkts, traffic.ip6.num);
570 drain_crypto_buffers(struct lcore_conf *qconf)
573 struct ipsec_ctx *ctx;
575 /* drain inbound buffers*/
576 ctx = &qconf->inbound;
577 for (i = 0; i != ctx->nb_qps; i++) {
578 if (ctx->tbl[i].len != 0)
579 enqueue_cop_burst(ctx->tbl + i);
582 /* drain outbound buffers*/
583 ctx = &qconf->outbound;
584 for (i = 0; i != ctx->nb_qps; i++) {
585 if (ctx->tbl[i].len != 0)
586 enqueue_cop_burst(ctx->tbl + i);
591 drain_inbound_crypto_queues(const struct lcore_conf *qconf,
592 struct ipsec_ctx *ctx)
595 struct ipsec_traffic trf;
596 unsigned int lcoreid = rte_lcore_id();
598 if (app_sa_prm.enable == 0) {
600 /* dequeue packets from crypto-queue */
601 n = ipsec_inbound_cqp_dequeue(ctx, trf.ipsec.pkts,
602 RTE_DIM(trf.ipsec.pkts));
607 /* split traffic by ipv4-ipv6 */
608 split46_traffic(&trf, trf.ipsec.pkts, n);
610 ipsec_cqp_process(ctx, &trf);
612 /* process ipv4 packets */
613 if (trf.ip4.num != 0) {
614 inbound_sp_sa(ctx->sp4_ctx, ctx->sa_ctx, &trf.ip4, 0,
615 &core_statistics[lcoreid].inbound.spd4);
616 route4_pkts(qconf->rt4_ctx, trf.ip4.pkts, trf.ip4.num);
619 /* process ipv6 packets */
620 if (trf.ip6.num != 0) {
621 inbound_sp_sa(ctx->sp6_ctx, ctx->sa_ctx, &trf.ip6, 0,
622 &core_statistics[lcoreid].inbound.spd6);
623 route6_pkts(qconf->rt6_ctx, trf.ip6.pkts, trf.ip6.num);
628 drain_outbound_crypto_queues(const struct lcore_conf *qconf,
629 struct ipsec_ctx *ctx)
632 struct ipsec_traffic trf;
634 if (app_sa_prm.enable == 0) {
636 /* dequeue packets from crypto-queue */
637 n = ipsec_outbound_cqp_dequeue(ctx, trf.ipsec.pkts,
638 RTE_DIM(trf.ipsec.pkts));
643 /* split traffic by ipv4-ipv6 */
644 split46_traffic(&trf, trf.ipsec.pkts, n);
646 ipsec_cqp_process(ctx, &trf);
648 /* process ipv4 packets */
649 if (trf.ip4.num != 0)
650 route4_pkts(qconf->rt4_ctx, trf.ip4.pkts, trf.ip4.num);
652 /* process ipv6 packets */
653 if (trf.ip6.num != 0)
654 route6_pkts(qconf->rt6_ctx, trf.ip6.pkts, trf.ip6.num);
657 /* main processing loop */
659 ipsec_poll_mode_worker(void)
661 struct rte_mbuf *pkts[MAX_PKT_BURST];
663 uint64_t prev_tsc, diff_tsc, cur_tsc;
667 struct lcore_conf *qconf;
668 int32_t rc, socket_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 lcore_rx_queue *rxql;
674 lcore_id = rte_lcore_id();
675 qconf = &lcore_conf[lcore_id];
676 rxql = qconf->rx_queue_list;
677 socket_id = rte_lcore_to_socket_id(lcore_id);
679 qconf->rt4_ctx = socket_ctx[socket_id].rt_ip4;
680 qconf->rt6_ctx = socket_ctx[socket_id].rt_ip6;
681 qconf->inbound.sp4_ctx = socket_ctx[socket_id].sp_ip4_in;
682 qconf->inbound.sp6_ctx = socket_ctx[socket_id].sp_ip6_in;
683 qconf->inbound.sa_ctx = socket_ctx[socket_id].sa_in;
684 qconf->inbound.cdev_map = cdev_map_in;
685 qconf->inbound.session_pool = socket_ctx[socket_id].session_pool;
686 qconf->inbound.session_priv_pool =
687 socket_ctx[socket_id].session_priv_pool;
688 qconf->outbound.sp4_ctx = socket_ctx[socket_id].sp_ip4_out;
689 qconf->outbound.sp6_ctx = socket_ctx[socket_id].sp_ip6_out;
690 qconf->outbound.sa_ctx = socket_ctx[socket_id].sa_out;
691 qconf->outbound.cdev_map = cdev_map_out;
692 qconf->outbound.session_pool = socket_ctx[socket_id].session_pool;
693 qconf->outbound.session_priv_pool =
694 socket_ctx[socket_id].session_priv_pool;
695 qconf->frag.pool_indir = socket_ctx[socket_id].mbuf_pool_indir;
697 rc = ipsec_sad_lcore_cache_init(app_sa_prm.cache_sz);
700 "SAD cache init on lcore %u, failed with code: %d\n",
705 if (qconf->nb_rx_queue == 0) {
706 RTE_LOG(DEBUG, IPSEC, "lcore %u has nothing to do\n",
711 RTE_LOG(INFO, IPSEC, "entering main loop on lcore %u\n", lcore_id);
713 for (i = 0; i < qconf->nb_rx_queue; i++) {
714 portid = rxql[i].port_id;
715 queueid = rxql[i].queue_id;
717 " -- lcoreid=%u portid=%u rxqueueid=%hhu\n",
718 lcore_id, portid, queueid);
721 while (!force_quit) {
722 cur_tsc = rte_rdtsc();
724 /* TX queue buffer drain */
725 diff_tsc = cur_tsc - prev_tsc;
727 if (unlikely(diff_tsc > drain_tsc)) {
728 drain_tx_buffers(qconf);
729 drain_crypto_buffers(qconf);
733 for (i = 0; i < qconf->nb_rx_queue; ++i) {
735 /* Read packets from RX queues */
736 portid = rxql[i].port_id;
737 queueid = rxql[i].queue_id;
738 nb_rx = rte_eth_rx_burst(portid, queueid,
739 pkts, MAX_PKT_BURST);
742 core_stats_update_rx(nb_rx);
743 process_pkts(qconf, pkts, nb_rx, portid);
746 /* dequeue and process completed crypto-ops */
747 if (is_unprotected_port(portid))
748 drain_inbound_crypto_queues(qconf,
751 drain_outbound_crypto_queues(qconf,
758 check_flow_params(uint16_t fdir_portid, uint8_t fdir_qid)
764 for (i = 0; i < nb_lcore_params; ++i) {
765 portid = lcore_params_array[i].port_id;
766 if (portid == fdir_portid) {
767 queueid = lcore_params_array[i].queue_id;
768 if (queueid == fdir_qid)
772 if (i == nb_lcore_params - 1)
780 check_poll_mode_params(struct eh_conf *eh_conf)
790 if (eh_conf->mode != EH_PKT_TRANSFER_MODE_POLL)
793 if (lcore_params == NULL) {
794 printf("Error: No port/queue/core mappings\n");
798 for (i = 0; i < nb_lcore_params; ++i) {
799 lcore = lcore_params[i].lcore_id;
800 if (!rte_lcore_is_enabled(lcore)) {
801 printf("error: lcore %hhu is not enabled in "
802 "lcore mask\n", lcore);
805 socket_id = rte_lcore_to_socket_id(lcore);
806 if (socket_id != 0 && numa_on == 0) {
807 printf("warning: lcore %hhu is on socket %d "
811 portid = lcore_params[i].port_id;
812 if ((enabled_port_mask & (1 << portid)) == 0) {
813 printf("port %u is not enabled in port mask\n", portid);
816 if (!rte_eth_dev_is_valid_port(portid)) {
817 printf("port %u is not present on the board\n", portid);
825 get_port_nb_rx_queues(const uint16_t port)
830 for (i = 0; i < nb_lcore_params; ++i) {
831 if (lcore_params[i].port_id == port &&
832 lcore_params[i].queue_id > queue)
833 queue = lcore_params[i].queue_id;
835 return (uint8_t)(++queue);
839 init_lcore_rx_queues(void)
841 uint16_t i, nb_rx_queue;
844 for (i = 0; i < nb_lcore_params; ++i) {
845 lcore = lcore_params[i].lcore_id;
846 nb_rx_queue = lcore_conf[lcore].nb_rx_queue;
847 if (nb_rx_queue >= MAX_RX_QUEUE_PER_LCORE) {
848 printf("error: too many queues (%u) for lcore: %u\n",
849 nb_rx_queue + 1, lcore);
852 lcore_conf[lcore].rx_queue_list[nb_rx_queue].port_id =
853 lcore_params[i].port_id;
854 lcore_conf[lcore].rx_queue_list[nb_rx_queue].queue_id =
855 lcore_params[i].queue_id;
856 lcore_conf[lcore].nb_rx_queue++;
863 print_usage(const char *prgname)
865 fprintf(stderr, "%s [EAL options] --"
871 " [-w REPLAY_WINDOW_SIZE]"
875 " [-t STATS_INTERVAL]"
876 " [-s NUMBER_OF_MBUFS_IN_PKT_POOL]"
878 " --config (port,queue,lcore)[,(port,queue,lcore)]"
879 " [--single-sa SAIDX]"
880 " [--cryptodev_mask MASK]"
881 " [--transfer-mode MODE]"
882 " [--event-schedule-type TYPE]"
883 " [--" CMD_LINE_OPT_RX_OFFLOAD " RX_OFFLOAD_MASK]"
884 " [--" CMD_LINE_OPT_TX_OFFLOAD " TX_OFFLOAD_MASK]"
885 " [--" CMD_LINE_OPT_REASSEMBLE " REASSEMBLE_TABLE_SIZE]"
886 " [--" CMD_LINE_OPT_MTU " MTU]"
888 " [--vector-size SIZE]"
889 " [--vector-tmo TIMEOUT in ns]"
891 " -p PORTMASK: Hexadecimal bitmask of ports to configure\n"
892 " -P : Enable promiscuous mode\n"
893 " -u PORTMASK: Hexadecimal bitmask of unprotected ports\n"
894 " -j FRAMESIZE: Data buffer size, minimum (and default)\n"
895 " value: RTE_MBUF_DEFAULT_BUF_SIZE\n"
896 " -l enables code-path that uses librte_ipsec\n"
897 " -w REPLAY_WINDOW_SIZE specifies IPsec SQN replay window\n"
898 " size for each SA\n"
900 " -a enables SA SQN atomic behaviour\n"
901 " -c specifies inbound SAD cache size,\n"
902 " zero value disables the cache (default value: 128)\n"
903 " -t specifies statistics screen update interval,\n"
904 " zero disables statistics screen (default value: 0)\n"
905 " -s number of mbufs in packet pool, if not specified number\n"
906 " of mbufs will be calculated based on number of cores,\n"
907 " ports and crypto queues\n"
908 " -f CONFIG_FILE: Configuration file\n"
909 " --config (port,queue,lcore): Rx queue configuration. In poll\n"
910 " mode determines which queues from\n"
911 " which ports are mapped to which cores.\n"
912 " In event mode this option is not used\n"
913 " as packets are dynamically scheduled\n"
915 " --single-sa SAIDX: In poll mode use single SA index for\n"
916 " outbound traffic, bypassing the SP\n"
917 " In event mode selects driver submode,\n"
918 " SA index value is ignored\n"
919 " --cryptodev_mask MASK: Hexadecimal bitmask of the crypto\n"
920 " devices to configure\n"
921 " --transfer-mode MODE\n"
922 " \"poll\" : Packet transfer via polling (default)\n"
923 " \"event\" : Packet transfer via event device\n"
924 " --event-schedule-type TYPE queue schedule type, used only when\n"
925 " transfer mode is set to event\n"
926 " \"ordered\" : Ordered (default)\n"
927 " \"atomic\" : Atomic\n"
928 " \"parallel\" : Parallel\n"
929 " --" CMD_LINE_OPT_RX_OFFLOAD
930 ": bitmask of the RX HW offload capabilities to enable/use\n"
931 " (RTE_ETH_RX_OFFLOAD_*)\n"
932 " --" CMD_LINE_OPT_TX_OFFLOAD
933 ": bitmask of the TX HW offload capabilities to enable/use\n"
934 " (RTE_ETH_TX_OFFLOAD_*)\n"
935 " --" CMD_LINE_OPT_REASSEMBLE " NUM"
936 ": max number of entries in reassemble(fragment) table\n"
937 " (zero (default value) disables reassembly)\n"
938 " --" CMD_LINE_OPT_MTU " MTU"
939 ": MTU value on all ports (default value: 1500)\n"
940 " outgoing packets with bigger size will be fragmented\n"
941 " incoming packets with bigger size will be discarded\n"
942 " --" CMD_LINE_OPT_FRAG_TTL " FRAG_TTL_NS"
943 ": fragments lifetime in nanoseconds, default\n"
944 " and maximum value is 10.000.000.000 ns (10 s)\n"
945 " --event-vector enables event vectorization\n"
946 " --vector-size Max vector size (default value: 16)\n"
947 " --vector-tmo Max vector timeout in nanoseconds"
948 " (default value: 102400)\n"
949 " --" CMD_LINE_OPT_PER_PORT_POOL " Enable per port mbuf pool\n"
950 " --" CMD_LINE_OPT_VECTOR_POOL_SZ " Vector pool size\n"
951 " (default value is based on mbuf count)\n"
957 parse_mask(const char *str, uint64_t *val)
963 t = strtoul(str, &end, 0);
964 if (errno != 0 || end[0] != 0)
972 parse_portmask(const char *portmask)
979 /* parse hexadecimal string */
980 pm = strtoul(portmask, &end, 16);
981 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
984 if ((pm == 0) && errno)
991 parse_decimal(const char *str)
996 num = strtoull(str, &end, 10);
997 if ((str[0] == '\0') || (end == NULL) || (*end != '\0')
1005 parse_config(const char *q_arg)
1008 const char *p, *p0 = q_arg;
1016 unsigned long int_fld[_NUM_FLD];
1017 char *str_fld[_NUM_FLD];
1021 nb_lcore_params = 0;
1023 while ((p = strchr(p0, '(')) != NULL) {
1025 p0 = strchr(p, ')');
1030 if (size >= sizeof(s))
1033 snprintf(s, sizeof(s), "%.*s", size, p);
1034 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') !=
1037 for (i = 0; i < _NUM_FLD; i++) {
1039 int_fld[i] = strtoul(str_fld[i], &end, 0);
1040 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
1043 if (nb_lcore_params >= MAX_LCORE_PARAMS) {
1044 printf("exceeded max number of lcore params: %hu\n",
1048 lcore_params_array[nb_lcore_params].port_id =
1049 (uint8_t)int_fld[FLD_PORT];
1050 lcore_params_array[nb_lcore_params].queue_id =
1051 (uint8_t)int_fld[FLD_QUEUE];
1052 lcore_params_array[nb_lcore_params].lcore_id =
1053 (uint8_t)int_fld[FLD_LCORE];
1056 lcore_params = lcore_params_array;
1061 print_app_sa_prm(const struct app_sa_prm *prm)
1063 printf("librte_ipsec usage: %s\n",
1064 (prm->enable == 0) ? "disabled" : "enabled");
1066 printf("replay window size: %u\n", prm->window_size);
1067 printf("ESN: %s\n", (prm->enable_esn == 0) ? "disabled" : "enabled");
1068 printf("SA flags: %#" PRIx64 "\n", prm->flags);
1069 printf("Frag TTL: %" PRIu64 " ns\n", frag_ttl_ns);
1073 parse_transfer_mode(struct eh_conf *conf, const char *optarg)
1075 if (!strcmp(CMD_LINE_ARG_POLL, optarg))
1076 conf->mode = EH_PKT_TRANSFER_MODE_POLL;
1077 else if (!strcmp(CMD_LINE_ARG_EVENT, optarg))
1078 conf->mode = EH_PKT_TRANSFER_MODE_EVENT;
1080 printf("Unsupported packet transfer mode\n");
1088 parse_schedule_type(struct eh_conf *conf, const char *optarg)
1090 struct eventmode_conf *em_conf = NULL;
1092 /* Get eventmode conf */
1093 em_conf = conf->mode_params;
1095 if (!strcmp(CMD_LINE_ARG_ORDERED, optarg))
1096 em_conf->ext_params.sched_type = RTE_SCHED_TYPE_ORDERED;
1097 else if (!strcmp(CMD_LINE_ARG_ATOMIC, optarg))
1098 em_conf->ext_params.sched_type = RTE_SCHED_TYPE_ATOMIC;
1099 else if (!strcmp(CMD_LINE_ARG_PARALLEL, optarg))
1100 em_conf->ext_params.sched_type = RTE_SCHED_TYPE_PARALLEL;
1102 printf("Unsupported queue schedule type\n");
1110 parse_args(int32_t argc, char **argv, struct eh_conf *eh_conf)
1115 int32_t option_index;
1116 char *prgname = argv[0];
1117 int32_t f_present = 0;
1118 struct eventmode_conf *em_conf = NULL;
1122 while ((opt = getopt_long(argc, argvopt, "aelp:Pu:f:j:w:c:t:s:",
1123 lgopts, &option_index)) != EOF) {
1127 enabled_port_mask = parse_portmask(optarg);
1128 if (enabled_port_mask == 0) {
1129 printf("invalid portmask\n");
1130 print_usage(prgname);
1135 printf("Promiscuous mode selected\n");
1139 unprotected_port_mask = parse_portmask(optarg);
1140 if (unprotected_port_mask == 0) {
1141 printf("invalid unprotected portmask\n");
1142 print_usage(prgname);
1147 if (f_present == 1) {
1148 printf("\"-f\" option present more than "
1150 print_usage(prgname);
1158 ret = parse_decimal(optarg);
1160 printf("Invalid number of buffers in a pool: "
1162 print_usage(prgname);
1166 nb_bufs_in_pool = ret;
1170 ret = parse_decimal(optarg);
1171 if (ret < RTE_MBUF_DEFAULT_BUF_SIZE ||
1173 printf("Invalid frame buffer size value: %s\n",
1175 print_usage(prgname);
1178 frame_buf_size = ret;
1179 printf("Custom frame buffer size %u\n", frame_buf_size);
1182 app_sa_prm.enable = 1;
1185 app_sa_prm.window_size = parse_decimal(optarg);
1188 app_sa_prm.enable_esn = 1;
1191 app_sa_prm.enable = 1;
1192 app_sa_prm.flags |= RTE_IPSEC_SAFLAG_SQN_ATOM;
1195 ret = parse_decimal(optarg);
1197 printf("Invalid SA cache size: %s\n", optarg);
1198 print_usage(prgname);
1201 app_sa_prm.cache_sz = ret;
1204 ret = parse_decimal(optarg);
1206 printf("Invalid interval value: %s\n", optarg);
1207 print_usage(prgname);
1210 stats_interval = ret;
1212 case CMD_LINE_OPT_CONFIG_NUM:
1213 ret = parse_config(optarg);
1215 printf("Invalid config\n");
1216 print_usage(prgname);
1220 case CMD_LINE_OPT_SINGLE_SA_NUM:
1221 ret = parse_decimal(optarg);
1222 if (ret == -1 || ret > UINT32_MAX) {
1223 printf("Invalid argument[sa_idx]\n");
1224 print_usage(prgname);
1230 single_sa_idx = ret;
1231 eh_conf->ipsec_mode = EH_IPSEC_MODE_TYPE_DRIVER;
1232 printf("Configured with single SA index %u\n",
1235 case CMD_LINE_OPT_CRYPTODEV_MASK_NUM:
1236 ret = parse_portmask(optarg);
1238 printf("Invalid argument[portmask]\n");
1239 print_usage(prgname);
1244 enabled_cryptodev_mask = ret;
1247 case CMD_LINE_OPT_TRANSFER_MODE_NUM:
1248 ret = parse_transfer_mode(eh_conf, optarg);
1250 printf("Invalid packet transfer mode\n");
1251 print_usage(prgname);
1256 case CMD_LINE_OPT_SCHEDULE_TYPE_NUM:
1257 ret = parse_schedule_type(eh_conf, optarg);
1259 printf("Invalid queue schedule type\n");
1260 print_usage(prgname);
1265 case CMD_LINE_OPT_RX_OFFLOAD_NUM:
1266 ret = parse_mask(optarg, &dev_rx_offload);
1268 printf("Invalid argument for \'%s\': %s\n",
1269 CMD_LINE_OPT_RX_OFFLOAD, optarg);
1270 print_usage(prgname);
1274 case CMD_LINE_OPT_TX_OFFLOAD_NUM:
1275 ret = parse_mask(optarg, &dev_tx_offload);
1277 printf("Invalid argument for \'%s\': %s\n",
1278 CMD_LINE_OPT_TX_OFFLOAD, optarg);
1279 print_usage(prgname);
1283 case CMD_LINE_OPT_REASSEMBLE_NUM:
1284 ret = parse_decimal(optarg);
1285 if (ret < 0 || ret > UINT32_MAX) {
1286 printf("Invalid argument for \'%s\': %s\n",
1287 CMD_LINE_OPT_REASSEMBLE, optarg);
1288 print_usage(prgname);
1293 case CMD_LINE_OPT_MTU_NUM:
1294 ret = parse_decimal(optarg);
1295 if (ret < 0 || ret > RTE_IPV4_MAX_PKT_LEN) {
1296 printf("Invalid argument for \'%s\': %s\n",
1297 CMD_LINE_OPT_MTU, optarg);
1298 print_usage(prgname);
1303 case CMD_LINE_OPT_FRAG_TTL_NUM:
1304 ret = parse_decimal(optarg);
1305 if (ret < 0 || ret > MAX_FRAG_TTL_NS) {
1306 printf("Invalid argument for \'%s\': %s\n",
1307 CMD_LINE_OPT_MTU, optarg);
1308 print_usage(prgname);
1313 case CMD_LINE_OPT_EVENT_VECTOR_NUM:
1314 em_conf = eh_conf->mode_params;
1315 em_conf->ext_params.event_vector = 1;
1317 case CMD_LINE_OPT_VECTOR_SIZE_NUM:
1318 ret = parse_decimal(optarg);
1320 if (ret > MAX_PKT_BURST) {
1321 printf("Invalid argument for \'%s\': %s\n",
1322 CMD_LINE_OPT_VECTOR_SIZE, optarg);
1323 print_usage(prgname);
1326 em_conf = eh_conf->mode_params;
1327 em_conf->ext_params.vector_size = ret;
1329 case CMD_LINE_OPT_VECTOR_TIMEOUT_NUM:
1330 ret = parse_decimal(optarg);
1332 em_conf = eh_conf->mode_params;
1333 em_conf->vector_tmo_ns = ret;
1335 case CMD_LINE_OPT_VECTOR_POOL_SZ_NUM:
1336 ret = parse_decimal(optarg);
1338 em_conf = eh_conf->mode_params;
1339 em_conf->vector_pool_sz = ret;
1341 case CMD_LINE_OPT_PER_PORT_POOL_NUM:
1345 print_usage(prgname);
1350 if (f_present == 0) {
1351 printf("Mandatory option \"-f\" not present\n");
1355 /* check do we need to enable multi-seg support */
1356 if (multi_seg_required()) {
1357 /* legacy mode doesn't support multi-seg */
1358 app_sa_prm.enable = 1;
1359 printf("frame buf size: %u, mtu: %u, "
1360 "number of reassemble entries: %u\n"
1361 "multi-segment support is required\n",
1362 frame_buf_size, mtu_size, frag_tbl_sz);
1365 print_app_sa_prm(&app_sa_prm);
1368 argv[optind-1] = prgname;
1371 optind = 1; /* reset getopt lib */
1376 print_ethaddr(const char *name, const struct rte_ether_addr *eth_addr)
1378 char buf[RTE_ETHER_ADDR_FMT_SIZE];
1379 rte_ether_format_addr(buf, RTE_ETHER_ADDR_FMT_SIZE, eth_addr);
1380 printf("%s%s", name, buf);
1384 * Update destination ethaddr for the port.
1387 add_dst_ethaddr(uint16_t port, const struct rte_ether_addr *addr)
1389 if (port >= RTE_DIM(ethaddr_tbl))
1392 ethaddr_tbl[port].dst = ETHADDR_TO_UINT64(addr);
1396 /* Check the link status of all ports in up to 9s, and print them finally */
1398 check_all_ports_link_status(uint32_t port_mask)
1400 #define CHECK_INTERVAL 100 /* 100ms */
1401 #define MAX_CHECK_TIME 90 /* 9s (90 * 100ms) in total */
1403 uint8_t count, all_ports_up, print_flag = 0;
1404 struct rte_eth_link link;
1406 char link_status_text[RTE_ETH_LINK_MAX_STR_LEN];
1408 printf("\nChecking link status");
1410 for (count = 0; count <= MAX_CHECK_TIME; count++) {
1412 RTE_ETH_FOREACH_DEV(portid) {
1413 if ((port_mask & (1 << portid)) == 0)
1415 memset(&link, 0, sizeof(link));
1416 ret = rte_eth_link_get_nowait(portid, &link);
1419 if (print_flag == 1)
1420 printf("Port %u link get failed: %s\n",
1421 portid, rte_strerror(-ret));
1424 /* print link status if flag set */
1425 if (print_flag == 1) {
1426 rte_eth_link_to_str(link_status_text,
1427 sizeof(link_status_text), &link);
1428 printf("Port %d %s\n", portid,
1432 /* clear all_ports_up flag if any link down */
1433 if (link.link_status == RTE_ETH_LINK_DOWN) {
1438 /* after finally printing all link status, get out */
1439 if (print_flag == 1)
1442 if (all_ports_up == 0) {
1445 rte_delay_ms(CHECK_INTERVAL);
1448 /* set the print_flag if all ports up or timeout */
1449 if (all_ports_up == 1 || count == (MAX_CHECK_TIME - 1)) {
1457 add_mapping(struct rte_hash *map, const char *str, uint16_t cdev_id,
1458 uint16_t qp, struct lcore_params *params,
1459 struct ipsec_ctx *ipsec_ctx,
1460 const struct rte_cryptodev_capabilities *cipher,
1461 const struct rte_cryptodev_capabilities *auth,
1462 const struct rte_cryptodev_capabilities *aead)
1466 struct cdev_key key = { 0 };
1468 key.lcore_id = params->lcore_id;
1470 key.cipher_algo = cipher->sym.cipher.algo;
1472 key.auth_algo = auth->sym.auth.algo;
1474 key.aead_algo = aead->sym.aead.algo;
1476 ret = rte_hash_lookup(map, &key);
1480 for (i = 0; i < ipsec_ctx->nb_qps; i++)
1481 if (ipsec_ctx->tbl[i].id == cdev_id)
1484 if (i == ipsec_ctx->nb_qps) {
1485 if (ipsec_ctx->nb_qps == MAX_QP_PER_LCORE) {
1486 printf("Maximum number of crypto devices assigned to "
1487 "a core, increase MAX_QP_PER_LCORE value\n");
1490 ipsec_ctx->tbl[i].id = cdev_id;
1491 ipsec_ctx->tbl[i].qp = qp;
1492 ipsec_ctx->nb_qps++;
1493 printf("%s cdev mapping: lcore %u using cdev %u qp %u "
1494 "(cdev_id_qp %lu)\n", str, key.lcore_id,
1498 ret = rte_hash_add_key_data(map, &key, (void *)i);
1500 printf("Failed to insert cdev mapping for (lcore %u, "
1501 "cdev %u, qp %u), errno %d\n",
1502 key.lcore_id, ipsec_ctx->tbl[i].id,
1503 ipsec_ctx->tbl[i].qp, ret);
1511 add_cdev_mapping(struct rte_cryptodev_info *dev_info, uint16_t cdev_id,
1512 uint16_t qp, struct lcore_params *params)
1515 const struct rte_cryptodev_capabilities *i, *j;
1516 struct rte_hash *map;
1517 struct lcore_conf *qconf;
1518 struct ipsec_ctx *ipsec_ctx;
1521 qconf = &lcore_conf[params->lcore_id];
1523 if ((unprotected_port_mask & (1 << params->port_id)) == 0) {
1525 ipsec_ctx = &qconf->outbound;
1529 ipsec_ctx = &qconf->inbound;
1533 /* Required cryptodevs with operation chaining */
1534 if (!(dev_info->feature_flags &
1535 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING))
1538 for (i = dev_info->capabilities;
1539 i->op != RTE_CRYPTO_OP_TYPE_UNDEFINED; i++) {
1540 if (i->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
1543 if (i->sym.xform_type == RTE_CRYPTO_SYM_XFORM_AEAD) {
1544 ret |= add_mapping(map, str, cdev_id, qp, params,
1545 ipsec_ctx, NULL, NULL, i);
1549 if (i->sym.xform_type != RTE_CRYPTO_SYM_XFORM_CIPHER)
1552 for (j = dev_info->capabilities;
1553 j->op != RTE_CRYPTO_OP_TYPE_UNDEFINED; j++) {
1554 if (j->op != RTE_CRYPTO_OP_TYPE_SYMMETRIC)
1557 if (j->sym.xform_type != RTE_CRYPTO_SYM_XFORM_AUTH)
1560 ret |= add_mapping(map, str, cdev_id, qp, params,
1561 ipsec_ctx, i, j, NULL);
1568 /* Check if the device is enabled by cryptodev_mask */
1570 check_cryptodev_mask(uint8_t cdev_id)
1572 if (enabled_cryptodev_mask & (1 << cdev_id))
1579 cryptodevs_init(uint16_t req_queue_num)
1581 struct rte_cryptodev_config dev_conf;
1582 struct rte_cryptodev_qp_conf qp_conf;
1583 uint16_t idx, max_nb_qps, qp, total_nb_qps, i;
1585 struct rte_hash_parameters params = { 0 };
1587 const uint64_t mseg_flag = multi_seg_required() ?
1588 RTE_CRYPTODEV_FF_IN_PLACE_SGL : 0;
1590 params.entries = CDEV_MAP_ENTRIES;
1591 params.key_len = sizeof(struct cdev_key);
1592 params.hash_func = rte_jhash;
1593 params.hash_func_init_val = 0;
1594 params.socket_id = rte_socket_id();
1596 params.name = "cdev_map_in";
1597 cdev_map_in = rte_hash_create(¶ms);
1598 if (cdev_map_in == NULL)
1599 rte_panic("Failed to create cdev_map hash table, errno = %d\n",
1602 params.name = "cdev_map_out";
1603 cdev_map_out = rte_hash_create(¶ms);
1604 if (cdev_map_out == NULL)
1605 rte_panic("Failed to create cdev_map hash table, errno = %d\n",
1608 printf("lcore/cryptodev/qp mappings:\n");
1612 for (cdev_id = 0; cdev_id < rte_cryptodev_count(); cdev_id++) {
1613 struct rte_cryptodev_info cdev_info;
1615 if (check_cryptodev_mask((uint8_t)cdev_id))
1618 rte_cryptodev_info_get(cdev_id, &cdev_info);
1620 if ((mseg_flag & cdev_info.feature_flags) != mseg_flag)
1621 rte_exit(EXIT_FAILURE,
1622 "Device %hd does not support \'%s\' feature\n",
1624 rte_cryptodev_get_feature_name(mseg_flag));
1626 if (nb_lcore_params > cdev_info.max_nb_queue_pairs)
1627 max_nb_qps = cdev_info.max_nb_queue_pairs;
1629 max_nb_qps = nb_lcore_params;
1633 while (qp < max_nb_qps && i < nb_lcore_params) {
1634 if (add_cdev_mapping(&cdev_info, cdev_id, qp,
1635 &lcore_params[idx]))
1638 idx = idx % nb_lcore_params;
1642 qp = RTE_MIN(max_nb_qps, RTE_MAX(req_queue_num, qp));
1647 dev_conf.socket_id = rte_cryptodev_socket_id(cdev_id);
1648 dev_conf.nb_queue_pairs = qp;
1649 dev_conf.ff_disable = RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO;
1651 uint32_t dev_max_sess = cdev_info.sym.max_nb_sessions;
1652 if (dev_max_sess != 0 &&
1653 dev_max_sess < get_nb_crypto_sessions())
1654 rte_exit(EXIT_FAILURE,
1655 "Device does not support at least %u "
1656 "sessions", get_nb_crypto_sessions());
1658 if (rte_cryptodev_configure(cdev_id, &dev_conf))
1659 rte_panic("Failed to initialize cryptodev %u\n",
1662 qp_conf.nb_descriptors = CDEV_QUEUE_DESC;
1663 qp_conf.mp_session =
1664 socket_ctx[dev_conf.socket_id].session_pool;
1665 qp_conf.mp_session_private =
1666 socket_ctx[dev_conf.socket_id].session_priv_pool;
1667 for (qp = 0; qp < dev_conf.nb_queue_pairs; qp++)
1668 if (rte_cryptodev_queue_pair_setup(cdev_id, qp,
1669 &qp_conf, dev_conf.socket_id))
1670 rte_panic("Failed to setup queue %u for "
1671 "cdev_id %u\n", 0, cdev_id);
1673 if (rte_cryptodev_start(cdev_id))
1674 rte_panic("Failed to start cryptodev %u\n",
1680 return total_nb_qps;
1684 port_init(uint16_t portid, uint64_t req_rx_offloads, uint64_t req_tx_offloads)
1686 struct rte_eth_dev_info dev_info;
1687 struct rte_eth_txconf *txconf;
1688 uint16_t nb_tx_queue, nb_rx_queue;
1689 uint16_t tx_queueid, rx_queueid, queue, lcore_id;
1690 int32_t ret, socket_id;
1691 struct lcore_conf *qconf;
1692 struct rte_ether_addr ethaddr;
1693 struct rte_eth_conf local_port_conf = port_conf;
1695 ret = rte_eth_dev_info_get(portid, &dev_info);
1697 rte_exit(EXIT_FAILURE,
1698 "Error during getting device (port %u) info: %s\n",
1699 portid, strerror(-ret));
1701 /* limit allowed HW offloads, as user requested */
1702 dev_info.rx_offload_capa &= dev_rx_offload;
1703 dev_info.tx_offload_capa &= dev_tx_offload;
1705 printf("Configuring device port %u:\n", portid);
1707 ret = rte_eth_macaddr_get(portid, ðaddr);
1709 rte_exit(EXIT_FAILURE,
1710 "Error getting MAC address (port %u): %s\n",
1711 portid, rte_strerror(-ret));
1713 ethaddr_tbl[portid].src = ETHADDR_TO_UINT64(ðaddr);
1714 print_ethaddr("Address: ", ðaddr);
1717 nb_rx_queue = get_port_nb_rx_queues(portid);
1718 nb_tx_queue = nb_lcores;
1720 if (nb_rx_queue > dev_info.max_rx_queues)
1721 rte_exit(EXIT_FAILURE, "Error: queue %u not available "
1722 "(max rx queue is %u)\n",
1723 nb_rx_queue, dev_info.max_rx_queues);
1725 if (nb_tx_queue > dev_info.max_tx_queues)
1726 rte_exit(EXIT_FAILURE, "Error: queue %u not available "
1727 "(max tx queue is %u)\n",
1728 nb_tx_queue, dev_info.max_tx_queues);
1730 printf("Creating queues: nb_rx_queue=%d nb_tx_queue=%u...\n",
1731 nb_rx_queue, nb_tx_queue);
1733 local_port_conf.rxmode.mtu = mtu_size;
1735 if (multi_seg_required()) {
1736 local_port_conf.rxmode.offloads |= RTE_ETH_RX_OFFLOAD_SCATTER;
1737 local_port_conf.txmode.offloads |= RTE_ETH_TX_OFFLOAD_MULTI_SEGS;
1740 local_port_conf.rxmode.offloads |= req_rx_offloads;
1741 local_port_conf.txmode.offloads |= req_tx_offloads;
1743 /* Check that all required capabilities are supported */
1744 if ((local_port_conf.rxmode.offloads & dev_info.rx_offload_capa) !=
1745 local_port_conf.rxmode.offloads)
1746 rte_exit(EXIT_FAILURE,
1747 "Error: port %u required RX offloads: 0x%" PRIx64
1748 ", available RX offloads: 0x%" PRIx64 "\n",
1749 portid, local_port_conf.rxmode.offloads,
1750 dev_info.rx_offload_capa);
1752 if ((local_port_conf.txmode.offloads & dev_info.tx_offload_capa) !=
1753 local_port_conf.txmode.offloads)
1754 rte_exit(EXIT_FAILURE,
1755 "Error: port %u required TX offloads: 0x%" PRIx64
1756 ", available TX offloads: 0x%" PRIx64 "\n",
1757 portid, local_port_conf.txmode.offloads,
1758 dev_info.tx_offload_capa);
1760 if (dev_info.tx_offload_capa & RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE)
1761 local_port_conf.txmode.offloads |=
1762 RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE;
1764 printf("port %u configuring rx_offloads=0x%" PRIx64
1765 ", tx_offloads=0x%" PRIx64 "\n",
1766 portid, local_port_conf.rxmode.offloads,
1767 local_port_conf.txmode.offloads);
1769 local_port_conf.rx_adv_conf.rss_conf.rss_hf &=
1770 dev_info.flow_type_rss_offloads;
1771 if (local_port_conf.rx_adv_conf.rss_conf.rss_hf !=
1772 port_conf.rx_adv_conf.rss_conf.rss_hf) {
1773 printf("Port %u modified RSS hash function based on hardware support,"
1774 "requested:%#"PRIx64" configured:%#"PRIx64"\n",
1776 port_conf.rx_adv_conf.rss_conf.rss_hf,
1777 local_port_conf.rx_adv_conf.rss_conf.rss_hf);
1780 ret = rte_eth_dev_configure(portid, nb_rx_queue, nb_tx_queue,
1783 rte_exit(EXIT_FAILURE, "Cannot configure device: "
1784 "err=%d, port=%d\n", ret, portid);
1786 ret = rte_eth_dev_adjust_nb_rx_tx_desc(portid, &nb_rxd, &nb_txd);
1788 rte_exit(EXIT_FAILURE, "Cannot adjust number of descriptors: "
1789 "err=%d, port=%d\n", ret, portid);
1791 /* init one TX queue per lcore */
1793 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1794 if (rte_lcore_is_enabled(lcore_id) == 0)
1798 socket_id = (uint8_t)rte_lcore_to_socket_id(lcore_id);
1803 printf("Setup txq=%u,%d,%d\n", lcore_id, tx_queueid, socket_id);
1805 txconf = &dev_info.default_txconf;
1806 txconf->offloads = local_port_conf.txmode.offloads;
1808 ret = rte_eth_tx_queue_setup(portid, tx_queueid, nb_txd,
1811 rte_exit(EXIT_FAILURE, "rte_eth_tx_queue_setup: "
1812 "err=%d, port=%d\n", ret, portid);
1814 qconf = &lcore_conf[lcore_id];
1815 qconf->tx_queue_id[portid] = tx_queueid;
1817 /* Pre-populate pkt offloads based on capabilities */
1818 qconf->outbound.ipv4_offloads = RTE_MBUF_F_TX_IPV4;
1819 qconf->outbound.ipv6_offloads = RTE_MBUF_F_TX_IPV6;
1820 if (local_port_conf.txmode.offloads & RTE_ETH_TX_OFFLOAD_IPV4_CKSUM)
1821 qconf->outbound.ipv4_offloads |= RTE_MBUF_F_TX_IP_CKSUM;
1825 /* init RX queues */
1826 for (queue = 0; queue < qconf->nb_rx_queue; ++queue) {
1827 struct rte_eth_rxconf rxq_conf;
1828 struct rte_mempool *pool;
1830 if (portid != qconf->rx_queue_list[queue].port_id)
1833 rx_queueid = qconf->rx_queue_list[queue].queue_id;
1835 printf("Setup rxq=%d,%d,%d\n", portid, rx_queueid,
1838 rxq_conf = dev_info.default_rxconf;
1839 rxq_conf.offloads = local_port_conf.rxmode.offloads;
1842 pool = socket_ctx[socket_id].mbuf_pool[portid];
1844 pool = socket_ctx[socket_id].mbuf_pool[0];
1846 ret = rte_eth_rx_queue_setup(portid, rx_queueid,
1847 nb_rxd, socket_id, &rxq_conf, pool);
1849 rte_exit(EXIT_FAILURE,
1850 "rte_eth_rx_queue_setup: err=%d, "
1851 "port=%d\n", ret, portid);
1858 max_session_size(void)
1862 int16_t cdev_id, port_id, n;
1865 n = rte_cryptodev_count();
1866 for (cdev_id = 0; cdev_id != n; cdev_id++) {
1867 sz = rte_cryptodev_sym_get_private_session_size(cdev_id);
1871 * If crypto device is security capable, need to check the
1872 * size of security session as well.
1875 /* Get security context of the crypto device */
1876 sec_ctx = rte_cryptodev_get_sec_ctx(cdev_id);
1877 if (sec_ctx == NULL)
1880 /* Get size of security session */
1881 sz = rte_security_session_get_size(sec_ctx);
1886 RTE_ETH_FOREACH_DEV(port_id) {
1887 if ((enabled_port_mask & (1 << port_id)) == 0)
1890 sec_ctx = rte_eth_dev_get_sec_ctx(port_id);
1891 if (sec_ctx == NULL)
1894 sz = rte_security_session_get_size(sec_ctx);
1903 session_pool_init(struct socket_ctx *ctx, int32_t socket_id, size_t sess_sz)
1905 char mp_name[RTE_MEMPOOL_NAMESIZE];
1906 struct rte_mempool *sess_mp;
1909 snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
1910 "sess_mp_%u", socket_id);
1911 nb_sess = (get_nb_crypto_sessions() + CDEV_MP_CACHE_SZ *
1913 nb_sess = RTE_MAX(nb_sess, CDEV_MP_CACHE_SZ *
1914 CDEV_MP_CACHE_MULTIPLIER);
1915 sess_mp = rte_cryptodev_sym_session_pool_create(
1916 mp_name, nb_sess, sess_sz, CDEV_MP_CACHE_SZ, 0,
1918 ctx->session_pool = sess_mp;
1920 if (ctx->session_pool == NULL)
1921 rte_exit(EXIT_FAILURE,
1922 "Cannot init session pool on socket %d\n", socket_id);
1924 printf("Allocated session pool on socket %d\n", socket_id);
1928 session_priv_pool_init(struct socket_ctx *ctx, int32_t socket_id,
1931 char mp_name[RTE_MEMPOOL_NAMESIZE];
1932 struct rte_mempool *sess_mp;
1935 snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
1936 "sess_mp_priv_%u", socket_id);
1937 nb_sess = (get_nb_crypto_sessions() + CDEV_MP_CACHE_SZ *
1939 nb_sess = RTE_MAX(nb_sess, CDEV_MP_CACHE_SZ *
1940 CDEV_MP_CACHE_MULTIPLIER);
1941 sess_mp = rte_mempool_create(mp_name,
1945 0, NULL, NULL, NULL,
1948 ctx->session_priv_pool = sess_mp;
1950 if (ctx->session_priv_pool == NULL)
1951 rte_exit(EXIT_FAILURE,
1952 "Cannot init session priv pool on socket %d\n",
1955 printf("Allocated session priv pool on socket %d\n",
1960 pool_init(struct socket_ctx *ctx, int32_t socket_id, int portid,
1967 /* mbuf_pool is initialised by the pool_init() function*/
1968 if (socket_ctx[socket_id].mbuf_pool[portid])
1971 snprintf(s, sizeof(s), "mbuf_pool_%d_%d", socket_id, portid);
1972 ctx->mbuf_pool[portid] = rte_pktmbuf_pool_create(s, nb_mbuf,
1974 ipsec_metadata_size(),
1979 * if multi-segment support is enabled, then create a pool
1980 * for indirect mbufs. This is not per-port but global.
1982 ms = multi_seg_required();
1983 if (ms != 0 && !ctx->mbuf_pool_indir) {
1984 snprintf(s, sizeof(s), "mbuf_pool_indir_%d", socket_id);
1985 ctx->mbuf_pool_indir = rte_pktmbuf_pool_create(s, nb_mbuf,
1986 MEMPOOL_CACHE_SIZE, 0, 0, socket_id);
1989 if (ctx->mbuf_pool[portid] == NULL ||
1990 (ms != 0 && ctx->mbuf_pool_indir == NULL))
1991 rte_exit(EXIT_FAILURE, "Cannot init mbuf pool on socket %d\n",
1994 printf("Allocated mbuf pool on socket %d\n", socket_id);
1998 inline_ipsec_event_esn_overflow(struct rte_security_ctx *ctx, uint64_t md)
2000 struct ipsec_sa *sa;
2002 /* For inline protocol processing, the metadata in the event will
2003 * uniquely identify the security session which raised the event.
2004 * Application would then need the userdata it had registered with the
2005 * security session to process the event.
2008 sa = (struct ipsec_sa *)rte_security_get_userdata(ctx, md);
2011 /* userdata could not be retrieved */
2015 /* Sequence number over flow. SA need to be re-established */
2021 inline_ipsec_event_callback(uint16_t port_id, enum rte_eth_event_type type,
2022 void *param, void *ret_param)
2025 struct rte_eth_event_ipsec_desc *event_desc = NULL;
2026 struct rte_security_ctx *ctx = (struct rte_security_ctx *)
2027 rte_eth_dev_get_sec_ctx(port_id);
2029 RTE_SET_USED(param);
2031 if (type != RTE_ETH_EVENT_IPSEC)
2034 event_desc = ret_param;
2035 if (event_desc == NULL) {
2036 printf("Event descriptor not set\n");
2040 md = event_desc->metadata;
2042 if (event_desc->subtype == RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW)
2043 return inline_ipsec_event_esn_overflow(ctx, md);
2044 else if (event_desc->subtype >= RTE_ETH_EVENT_IPSEC_MAX) {
2045 printf("Invalid IPsec event reported\n");
2053 ethdev_reset_event_callback(uint16_t port_id,
2054 enum rte_eth_event_type type,
2055 void *param __rte_unused, void *ret_param __rte_unused)
2057 printf("Reset Event on port id %d type %d\n", port_id, type);
2058 printf("Force quit application");
2064 rx_callback(__rte_unused uint16_t port, __rte_unused uint16_t queue,
2065 struct rte_mbuf *pkt[], uint16_t nb_pkts,
2066 __rte_unused uint16_t max_pkts, void *user_param)
2070 struct lcore_conf *lc;
2071 struct rte_mbuf *mb;
2072 struct rte_ether_hdr *eth;
2078 for (i = 0; i != nb_pkts; i++) {
2081 eth = rte_pktmbuf_mtod(mb, struct rte_ether_hdr *);
2082 if (eth->ether_type == rte_cpu_to_be_16(RTE_ETHER_TYPE_IPV4)) {
2084 struct rte_ipv4_hdr *iph;
2086 iph = (struct rte_ipv4_hdr *)(eth + 1);
2087 if (rte_ipv4_frag_pkt_is_fragmented(iph)) {
2089 mb->l2_len = sizeof(*eth);
2090 mb->l3_len = sizeof(*iph);
2091 tm = (tm != 0) ? tm : rte_rdtsc();
2092 mb = rte_ipv4_frag_reassemble_packet(
2093 lc->frag.tbl, &lc->frag.dr,
2097 /* fix ip cksum after reassemble. */
2098 iph = rte_pktmbuf_mtod_offset(mb,
2099 struct rte_ipv4_hdr *,
2101 iph->hdr_checksum = 0;
2102 iph->hdr_checksum = rte_ipv4_cksum(iph);
2105 } else if (eth->ether_type ==
2106 rte_cpu_to_be_16(RTE_ETHER_TYPE_IPV6)) {
2108 struct rte_ipv6_hdr *iph;
2109 struct rte_ipv6_fragment_ext *fh;
2111 iph = (struct rte_ipv6_hdr *)(eth + 1);
2112 fh = rte_ipv6_frag_get_ipv6_fragment_header(iph);
2114 mb->l2_len = sizeof(*eth);
2115 mb->l3_len = (uintptr_t)fh - (uintptr_t)iph +
2117 tm = (tm != 0) ? tm : rte_rdtsc();
2118 mb = rte_ipv6_frag_reassemble_packet(
2119 lc->frag.tbl, &lc->frag.dr,
2122 /* fix l3_len after reassemble. */
2123 mb->l3_len = mb->l3_len - sizeof(*fh);
2131 /* some fragments were encountered, drain death row */
2133 rte_ip_frag_free_death_row(&lc->frag.dr, 0);
2140 reassemble_lcore_init(struct lcore_conf *lc, uint32_t cid)
2144 uint64_t frag_cycles;
2145 const struct lcore_rx_queue *rxq;
2146 const struct rte_eth_rxtx_callback *cb;
2148 /* create fragment table */
2149 sid = rte_lcore_to_socket_id(cid);
2150 frag_cycles = (rte_get_tsc_hz() + NS_PER_S - 1) /
2151 NS_PER_S * frag_ttl_ns;
2153 lc->frag.tbl = rte_ip_frag_table_create(frag_tbl_sz,
2154 FRAG_TBL_BUCKET_ENTRIES, frag_tbl_sz, frag_cycles, sid);
2155 if (lc->frag.tbl == NULL) {
2156 printf("%s(%u): failed to create fragment table of size: %u, "
2158 __func__, cid, frag_tbl_sz, rte_errno);
2162 /* setup reassemble RX callbacks for all queues */
2163 for (i = 0; i != lc->nb_rx_queue; i++) {
2165 rxq = lc->rx_queue_list + i;
2166 cb = rte_eth_add_rx_callback(rxq->port_id, rxq->queue_id,
2169 printf("%s(%u): failed to install RX callback for "
2170 "portid=%u, queueid=%u, error code: %d\n",
2172 rxq->port_id, rxq->queue_id, rte_errno);
2181 reassemble_init(void)
2187 for (i = 0; i != nb_lcore_params; i++) {
2188 lc = lcore_params[i].lcore_id;
2189 rc = reassemble_lcore_init(lcore_conf + lc, lc);
2198 create_default_ipsec_flow(uint16_t port_id, uint64_t rx_offloads)
2200 struct rte_flow_action action[2];
2201 struct rte_flow_item pattern[2];
2202 struct rte_flow_attr attr = {0};
2203 struct rte_flow_error err;
2204 struct rte_flow *flow;
2207 if (!(rx_offloads & RTE_ETH_RX_OFFLOAD_SECURITY))
2210 /* Add the default rte_flow to enable SECURITY for all ESP packets */
2212 pattern[0].type = RTE_FLOW_ITEM_TYPE_ESP;
2213 pattern[0].spec = NULL;
2214 pattern[0].mask = NULL;
2215 pattern[0].last = NULL;
2216 pattern[1].type = RTE_FLOW_ITEM_TYPE_END;
2218 action[0].type = RTE_FLOW_ACTION_TYPE_SECURITY;
2219 action[0].conf = NULL;
2220 action[1].type = RTE_FLOW_ACTION_TYPE_END;
2221 action[1].conf = NULL;
2225 ret = rte_flow_validate(port_id, &attr, pattern, action, &err);
2229 flow = rte_flow_create(port_id, &attr, pattern, action, &err);
2233 flow_info_tbl[port_id].rx_def_flow = flow;
2234 RTE_LOG(INFO, IPSEC,
2235 "Created default flow enabling SECURITY for all ESP traffic on port %d\n",
2240 signal_handler(int signum)
2242 if (signum == SIGINT || signum == SIGTERM) {
2243 printf("\n\nSignal %d received, preparing to exit...\n",
2250 ev_mode_sess_verify(struct ipsec_sa *sa, int nb_sa)
2252 struct rte_ipsec_session *ips;
2258 for (i = 0; i < nb_sa; i++) {
2259 ips = ipsec_get_primary_session(&sa[i]);
2260 if (ips->type != RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL)
2261 rte_exit(EXIT_FAILURE, "Event mode supports only "
2262 "inline protocol sessions\n");
2268 check_event_mode_params(struct eh_conf *eh_conf)
2270 struct eventmode_conf *em_conf = NULL;
2271 struct lcore_params *params;
2274 if (!eh_conf || !eh_conf->mode_params)
2277 /* Get eventmode conf */
2278 em_conf = eh_conf->mode_params;
2280 if (eh_conf->mode == EH_PKT_TRANSFER_MODE_POLL &&
2281 em_conf->ext_params.sched_type != SCHED_TYPE_NOT_SET) {
2282 printf("error: option --event-schedule-type applies only to "
2287 if (eh_conf->mode != EH_PKT_TRANSFER_MODE_EVENT)
2290 /* Set schedule type to ORDERED if it wasn't explicitly set by user */
2291 if (em_conf->ext_params.sched_type == SCHED_TYPE_NOT_SET)
2292 em_conf->ext_params.sched_type = RTE_SCHED_TYPE_ORDERED;
2295 * Event mode currently supports only inline protocol sessions.
2296 * If there are other types of sessions configured then exit with
2299 ev_mode_sess_verify(sa_in, nb_sa_in);
2300 ev_mode_sess_verify(sa_out, nb_sa_out);
2303 /* Option --config does not apply to event mode */
2304 if (nb_lcore_params > 0) {
2305 printf("error: option --config applies only to poll mode\n");
2310 * In order to use the same port_init routine for both poll and event
2311 * modes initialize lcore_params with one queue for each eth port
2313 lcore_params = lcore_params_array;
2314 RTE_ETH_FOREACH_DEV(portid) {
2315 if ((enabled_port_mask & (1 << portid)) == 0)
2318 params = &lcore_params[nb_lcore_params++];
2319 params->port_id = portid;
2320 params->queue_id = 0;
2321 params->lcore_id = rte_get_next_lcore(0, 0, 1);
2328 inline_sessions_free(struct sa_ctx *sa_ctx)
2330 struct rte_ipsec_session *ips;
2331 struct ipsec_sa *sa;
2338 for (i = 0; i < sa_ctx->nb_sa; i++) {
2340 sa = &sa_ctx->sa[i];
2344 ips = ipsec_get_primary_session(sa);
2345 if (ips->type != RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL &&
2346 ips->type != RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO)
2349 if (!rte_eth_dev_is_valid_port(sa->portid))
2352 ret = rte_security_session_destroy(
2353 rte_eth_dev_get_sec_ctx(sa->portid),
2356 RTE_LOG(ERR, IPSEC, "Failed to destroy security "
2357 "session type %d, spi %d\n",
2358 ips->type, sa->spi);
2363 calculate_nb_mbufs(uint16_t nb_ports, uint16_t nb_crypto_qp, uint32_t nb_rxq,
2366 return RTE_MAX((nb_rxq * nb_rxd +
2367 nb_ports * nb_lcores * MAX_PKT_BURST +
2368 nb_ports * nb_txq * nb_txd +
2369 nb_lcores * MEMPOOL_CACHE_SIZE +
2370 nb_crypto_qp * CDEV_QUEUE_DESC +
2371 nb_lcores * frag_tbl_sz *
2372 FRAG_TBL_BUCKET_ENTRIES),
2378 handle_telemetry_cmd_ipsec_secgw_stats(const char *cmd __rte_unused,
2379 const char *params, struct rte_tel_data *data)
2381 uint64_t total_pkts_dropped = 0, total_pkts_tx = 0, total_pkts_rx = 0;
2382 unsigned int coreid;
2384 rte_tel_data_start_dict(data);
2387 coreid = (uint32_t)atoi(params);
2388 if (rte_lcore_is_enabled(coreid) == 0)
2391 total_pkts_dropped = core_statistics[coreid].dropped;
2392 total_pkts_tx = core_statistics[coreid].tx;
2393 total_pkts_rx = core_statistics[coreid].rx;
2396 for (coreid = 0; coreid < RTE_MAX_LCORE; coreid++) {
2398 /* skip disabled cores */
2399 if (rte_lcore_is_enabled(coreid) == 0)
2402 total_pkts_dropped += core_statistics[coreid].dropped;
2403 total_pkts_tx += core_statistics[coreid].tx;
2404 total_pkts_rx += core_statistics[coreid].rx;
2408 /* add telemetry key/values pairs */
2409 rte_tel_data_add_dict_u64(data, "packets received",
2412 rte_tel_data_add_dict_u64(data, "packets transmitted",
2415 rte_tel_data_add_dict_u64(data, "packets dropped",
2416 total_pkts_dropped);
2423 update_lcore_statistics(struct ipsec_core_statistics *total, uint32_t coreid)
2425 struct ipsec_core_statistics *lcore_stats;
2427 /* skip disabled cores */
2428 if (rte_lcore_is_enabled(coreid) == 0)
2431 lcore_stats = &core_statistics[coreid];
2433 total->rx = lcore_stats->rx;
2434 total->dropped = lcore_stats->dropped;
2435 total->tx = lcore_stats->tx;
2437 /* outbound stats */
2438 total->outbound.spd6.protect += lcore_stats->outbound.spd6.protect;
2439 total->outbound.spd6.bypass += lcore_stats->outbound.spd6.bypass;
2440 total->outbound.spd6.discard += lcore_stats->outbound.spd6.discard;
2442 total->outbound.spd4.protect += lcore_stats->outbound.spd4.protect;
2443 total->outbound.spd4.bypass += lcore_stats->outbound.spd4.bypass;
2444 total->outbound.spd4.discard += lcore_stats->outbound.spd4.discard;
2446 total->outbound.sad.miss += lcore_stats->outbound.sad.miss;
2449 total->inbound.spd6.protect += lcore_stats->inbound.spd6.protect;
2450 total->inbound.spd6.bypass += lcore_stats->inbound.spd6.bypass;
2451 total->inbound.spd6.discard += lcore_stats->inbound.spd6.discard;
2453 total->inbound.spd4.protect += lcore_stats->inbound.spd4.protect;
2454 total->inbound.spd4.bypass += lcore_stats->inbound.spd4.bypass;
2455 total->inbound.spd4.discard += lcore_stats->inbound.spd4.discard;
2457 total->inbound.sad.miss += lcore_stats->inbound.sad.miss;
2461 total->lpm4.miss += lcore_stats->lpm4.miss;
2462 total->lpm6.miss += lcore_stats->lpm6.miss;
2466 update_statistics(struct ipsec_core_statistics *total, uint32_t coreid)
2468 memset(total, 0, sizeof(*total));
2470 if (coreid != UINT32_MAX) {
2471 update_lcore_statistics(total, coreid);
2473 for (coreid = 0; coreid < RTE_MAX_LCORE; coreid++)
2474 update_lcore_statistics(total, coreid);
2479 handle_telemetry_cmd_ipsec_secgw_stats_outbound(const char *cmd __rte_unused,
2480 const char *params, struct rte_tel_data *data)
2482 struct ipsec_core_statistics total_stats;
2484 struct rte_tel_data *spd4_data = rte_tel_data_alloc();
2485 struct rte_tel_data *spd6_data = rte_tel_data_alloc();
2486 struct rte_tel_data *sad_data = rte_tel_data_alloc();
2487 unsigned int coreid = UINT32_MAX;
2490 /* verify allocated telemetry data structures */
2491 if (!spd4_data || !spd6_data || !sad_data) {
2496 /* initialize telemetry data structs as dicts */
2497 rte_tel_data_start_dict(data);
2499 rte_tel_data_start_dict(spd4_data);
2500 rte_tel_data_start_dict(spd6_data);
2501 rte_tel_data_start_dict(sad_data);
2504 coreid = (uint32_t)atoi(params);
2505 if (rte_lcore_is_enabled(coreid) == 0) {
2511 update_statistics(&total_stats, coreid);
2513 /* add spd 4 telemetry key/values pairs */
2515 rte_tel_data_add_dict_u64(spd4_data, "protect",
2516 total_stats.outbound.spd4.protect);
2517 rte_tel_data_add_dict_u64(spd4_data, "bypass",
2518 total_stats.outbound.spd4.bypass);
2519 rte_tel_data_add_dict_u64(spd4_data, "discard",
2520 total_stats.outbound.spd4.discard);
2522 rte_tel_data_add_dict_container(data, "spd4", spd4_data, 0);
2524 /* add spd 6 telemetry key/values pairs */
2526 rte_tel_data_add_dict_u64(spd6_data, "protect",
2527 total_stats.outbound.spd6.protect);
2528 rte_tel_data_add_dict_u64(spd6_data, "bypass",
2529 total_stats.outbound.spd6.bypass);
2530 rte_tel_data_add_dict_u64(spd6_data, "discard",
2531 total_stats.outbound.spd6.discard);
2533 rte_tel_data_add_dict_container(data, "spd6", spd6_data, 0);
2535 /* add sad telemetry key/values pairs */
2537 rte_tel_data_add_dict_u64(sad_data, "miss",
2538 total_stats.outbound.sad.miss);
2540 rte_tel_data_add_dict_container(data, "sad", sad_data, 0);
2544 rte_tel_data_free(spd4_data);
2545 rte_tel_data_free(spd6_data);
2546 rte_tel_data_free(sad_data);
2552 handle_telemetry_cmd_ipsec_secgw_stats_inbound(const char *cmd __rte_unused,
2553 const char *params, struct rte_tel_data *data)
2555 struct ipsec_core_statistics total_stats;
2557 struct rte_tel_data *spd4_data = rte_tel_data_alloc();
2558 struct rte_tel_data *spd6_data = rte_tel_data_alloc();
2559 struct rte_tel_data *sad_data = rte_tel_data_alloc();
2560 unsigned int coreid = UINT32_MAX;
2563 /* verify allocated telemetry data structures */
2564 if (!spd4_data || !spd6_data || !sad_data) {
2569 /* initialize telemetry data structs as dicts */
2570 rte_tel_data_start_dict(data);
2571 rte_tel_data_start_dict(spd4_data);
2572 rte_tel_data_start_dict(spd6_data);
2573 rte_tel_data_start_dict(sad_data);
2575 /* add children dicts to parent dict */
2578 coreid = (uint32_t)atoi(params);
2579 if (rte_lcore_is_enabled(coreid) == 0) {
2585 update_statistics(&total_stats, coreid);
2587 /* add sad telemetry key/values pairs */
2589 rte_tel_data_add_dict_u64(sad_data, "miss",
2590 total_stats.inbound.sad.miss);
2592 rte_tel_data_add_dict_container(data, "sad", sad_data, 0);
2594 /* add spd 4 telemetry key/values pairs */
2596 rte_tel_data_add_dict_u64(spd4_data, "protect",
2597 total_stats.inbound.spd4.protect);
2598 rte_tel_data_add_dict_u64(spd4_data, "bypass",
2599 total_stats.inbound.spd4.bypass);
2600 rte_tel_data_add_dict_u64(spd4_data, "discard",
2601 total_stats.inbound.spd4.discard);
2603 rte_tel_data_add_dict_container(data, "spd4", spd4_data, 0);
2605 /* add spd 6 telemetry key/values pairs */
2607 rte_tel_data_add_dict_u64(spd6_data, "protect",
2608 total_stats.inbound.spd6.protect);
2609 rte_tel_data_add_dict_u64(spd6_data, "bypass",
2610 total_stats.inbound.spd6.bypass);
2611 rte_tel_data_add_dict_u64(spd6_data, "discard",
2612 total_stats.inbound.spd6.discard);
2614 rte_tel_data_add_dict_container(data, "spd6", spd6_data, 0);
2618 rte_tel_data_free(spd4_data);
2619 rte_tel_data_free(spd6_data);
2620 rte_tel_data_free(sad_data);
2626 handle_telemetry_cmd_ipsec_secgw_stats_routing(const char *cmd __rte_unused,
2627 const char *params, struct rte_tel_data *data)
2629 struct ipsec_core_statistics total_stats;
2631 struct rte_tel_data *lpm4_data = rte_tel_data_alloc();
2632 struct rte_tel_data *lpm6_data = rte_tel_data_alloc();
2633 unsigned int coreid = UINT32_MAX;
2636 /* verify allocated telemetry data structures */
2637 if (!lpm4_data || !lpm6_data) {
2642 /* initialize telemetry data structs as dicts */
2643 rte_tel_data_start_dict(data);
2644 rte_tel_data_start_dict(lpm4_data);
2645 rte_tel_data_start_dict(lpm6_data);
2649 coreid = (uint32_t)atoi(params);
2650 if (rte_lcore_is_enabled(coreid) == 0) {
2656 update_statistics(&total_stats, coreid);
2658 /* add lpm 4 telemetry key/values pairs */
2659 rte_tel_data_add_dict_u64(lpm4_data, "miss",
2660 total_stats.lpm4.miss);
2662 rte_tel_data_add_dict_container(data, "IPv4 LPM", lpm4_data, 0);
2664 /* add lpm 6 telemetry key/values pairs */
2665 rte_tel_data_add_dict_u64(lpm6_data, "miss",
2666 total_stats.lpm6.miss);
2668 rte_tel_data_add_dict_container(data, "IPv6 LPM", lpm6_data, 0);
2672 rte_tel_data_free(lpm4_data);
2673 rte_tel_data_free(lpm6_data);
2679 ipsec_secgw_telemetry_init(void)
2681 rte_telemetry_register_cmd("/examples/ipsec-secgw/stats",
2682 handle_telemetry_cmd_ipsec_secgw_stats,
2683 "Returns global stats. "
2684 "Optional Parameters: int <logical core id>");
2686 rte_telemetry_register_cmd("/examples/ipsec-secgw/stats/outbound",
2687 handle_telemetry_cmd_ipsec_secgw_stats_outbound,
2688 "Returns outbound global stats. "
2689 "Optional Parameters: int <logical core id>");
2691 rte_telemetry_register_cmd("/examples/ipsec-secgw/stats/inbound",
2692 handle_telemetry_cmd_ipsec_secgw_stats_inbound,
2693 "Returns inbound global stats. "
2694 "Optional Parameters: int <logical core id>");
2696 rte_telemetry_register_cmd("/examples/ipsec-secgw/stats/routing",
2697 handle_telemetry_cmd_ipsec_secgw_stats_routing,
2698 "Returns routing stats. "
2699 "Optional Parameters: int <logical core id>");
2704 main(int32_t argc, char **argv)
2707 uint32_t lcore_id, nb_txq, nb_rxq = 0;
2711 uint16_t portid, nb_crypto_qp, nb_ports = 0;
2712 uint64_t req_rx_offloads[RTE_MAX_ETHPORTS];
2713 uint64_t req_tx_offloads[RTE_MAX_ETHPORTS];
2714 struct eh_conf *eh_conf = NULL;
2717 nb_bufs_in_pool = 0;
2720 ret = rte_eal_init(argc, argv);
2722 rte_exit(EXIT_FAILURE, "Invalid EAL parameters\n");
2727 signal(SIGINT, signal_handler);
2728 signal(SIGTERM, signal_handler);
2730 /* initialize event helper configuration */
2731 eh_conf = eh_conf_init();
2732 if (eh_conf == NULL)
2733 rte_exit(EXIT_FAILURE, "Failed to init event helper config");
2735 /* parse application arguments (after the EAL ones) */
2736 ret = parse_args(argc, argv, eh_conf);
2738 rte_exit(EXIT_FAILURE, "Invalid parameters\n");
2740 ipsec_secgw_telemetry_init();
2742 /* parse configuration file */
2743 if (parse_cfg_file(cfgfile) < 0) {
2744 printf("parsing file \"%s\" failed\n",
2746 print_usage(argv[0]);
2750 if ((unprotected_port_mask & enabled_port_mask) !=
2751 unprotected_port_mask)
2752 rte_exit(EXIT_FAILURE, "Invalid unprotected portmask 0x%x\n",
2753 unprotected_port_mask);
2755 if (unprotected_port_mask && !nb_sa_in)
2756 rte_exit(EXIT_FAILURE, "Cannot use unprotected portmask without configured SA inbound\n");
2758 if (check_poll_mode_params(eh_conf) < 0)
2759 rte_exit(EXIT_FAILURE, "check_poll_mode_params failed\n");
2761 if (check_event_mode_params(eh_conf) < 0)
2762 rte_exit(EXIT_FAILURE, "check_event_mode_params failed\n");
2764 ret = init_lcore_rx_queues();
2766 rte_exit(EXIT_FAILURE, "init_lcore_rx_queues failed\n");
2768 nb_lcores = rte_lcore_count();
2770 sess_sz = max_session_size();
2773 * In event mode request minimum number of crypto queues
2774 * to be reserved equal to number of ports.
2776 if (eh_conf->mode == EH_PKT_TRANSFER_MODE_EVENT)
2777 nb_crypto_qp = rte_eth_dev_count_avail();
2781 nb_crypto_qp = cryptodevs_init(nb_crypto_qp);
2783 if (nb_bufs_in_pool == 0) {
2784 RTE_ETH_FOREACH_DEV(portid) {
2785 if ((enabled_port_mask & (1 << portid)) == 0)
2788 nb_rxq += get_port_nb_rx_queues(portid);
2793 nb_bufs_in_pool = calculate_nb_mbufs(nb_ports, nb_crypto_qp,
2797 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
2798 if (rte_lcore_is_enabled(lcore_id) == 0)
2802 socket_id = (uint8_t)rte_lcore_to_socket_id(lcore_id);
2806 if (per_port_pool) {
2807 RTE_ETH_FOREACH_DEV(portid) {
2808 if ((enabled_port_mask & (1 << portid)) == 0)
2811 pool_init(&socket_ctx[socket_id], socket_id,
2812 portid, nb_bufs_in_pool);
2815 pool_init(&socket_ctx[socket_id], socket_id, 0,
2819 if (socket_ctx[socket_id].session_pool)
2822 session_pool_init(&socket_ctx[socket_id], socket_id, sess_sz);
2823 session_priv_pool_init(&socket_ctx[socket_id], socket_id,
2826 printf("Number of mbufs in packet pool %d\n", nb_bufs_in_pool);
2828 RTE_ETH_FOREACH_DEV(portid) {
2829 if ((enabled_port_mask & (1 << portid)) == 0)
2832 sa_check_offloads(portid, &req_rx_offloads[portid],
2833 &req_tx_offloads[portid]);
2834 port_init(portid, req_rx_offloads[portid],
2835 req_tx_offloads[portid]);
2839 * Set the enabled port mask in helper config for use by helper
2840 * sub-system. This will be used while initializing devices using
2841 * helper sub-system.
2843 eh_conf->eth_portmask = enabled_port_mask;
2845 /* Initialize eventmode components */
2846 ret = eh_devs_init(eh_conf);
2848 rte_exit(EXIT_FAILURE, "eh_devs_init failed, err=%d\n", ret);
2851 RTE_ETH_FOREACH_DEV(portid) {
2852 if ((enabled_port_mask & (1 << portid)) == 0)
2855 ret = rte_eth_dev_start(portid);
2857 rte_exit(EXIT_FAILURE, "rte_eth_dev_start: "
2858 "err=%d, port=%d\n", ret, portid);
2860 /* Create flow after starting the device */
2861 create_default_ipsec_flow(portid, req_rx_offloads[portid]);
2864 * If enabled, put device in promiscuous mode.
2865 * This allows IO forwarding mode to forward packets
2866 * to itself through 2 cross-connected ports of the
2869 if (promiscuous_on) {
2870 ret = rte_eth_promiscuous_enable(portid);
2872 rte_exit(EXIT_FAILURE,
2873 "rte_eth_promiscuous_enable: err=%s, port=%d\n",
2874 rte_strerror(-ret), portid);
2877 rte_eth_dev_callback_register(portid, RTE_ETH_EVENT_INTR_RESET,
2878 ethdev_reset_event_callback, NULL);
2880 rte_eth_dev_callback_register(portid,
2881 RTE_ETH_EVENT_IPSEC, inline_ipsec_event_callback, NULL);
2884 /* fragment reassemble is enabled */
2885 if (frag_tbl_sz != 0) {
2886 ret = reassemble_init();
2888 rte_exit(EXIT_FAILURE, "failed at reassemble init");
2891 /* Replicate each context per socket */
2892 for (i = 0; i < NB_SOCKETS && i < rte_socket_count(); i++) {
2893 socket_id = rte_socket_id_by_idx(i);
2894 if ((socket_ctx[socket_id].session_pool != NULL) &&
2895 (socket_ctx[socket_id].sa_in == NULL) &&
2896 (socket_ctx[socket_id].sa_out == NULL)) {
2897 sa_init(&socket_ctx[socket_id], socket_id);
2898 sp4_init(&socket_ctx[socket_id], socket_id);
2899 sp6_init(&socket_ctx[socket_id], socket_id);
2900 rt_init(&socket_ctx[socket_id], socket_id);
2906 check_all_ports_link_status(enabled_port_mask);
2908 if (stats_interval > 0)
2909 rte_eal_alarm_set(stats_interval * US_PER_S,
2910 print_stats_cb, NULL);
2912 RTE_LOG(INFO, IPSEC, "Stats display disabled\n");
2914 /* launch per-lcore init on every lcore */
2915 rte_eal_mp_remote_launch(ipsec_launch_one_lcore, eh_conf, CALL_MAIN);
2916 RTE_LCORE_FOREACH_WORKER(lcore_id) {
2917 if (rte_eal_wait_lcore(lcore_id) < 0)
2921 /* Uninitialize eventmode components */
2922 ret = eh_devs_uninit(eh_conf);
2924 rte_exit(EXIT_FAILURE, "eh_devs_uninit failed, err=%d\n", ret);
2926 /* Free eventmode configuration memory */
2927 eh_conf_uninit(eh_conf);
2929 /* Destroy inline inbound and outbound sessions */
2930 for (i = 0; i < NB_SOCKETS && i < rte_socket_count(); i++) {
2931 socket_id = rte_socket_id_by_idx(i);
2932 inline_sessions_free(socket_ctx[socket_id].sa_in);
2933 inline_sessions_free(socket_ctx[socket_id].sa_out);
2936 for (cdev_id = 0; cdev_id < rte_cryptodev_count(); cdev_id++) {
2937 printf("Closing cryptodev %d...", cdev_id);
2938 rte_cryptodev_stop(cdev_id);
2939 rte_cryptodev_close(cdev_id);
2943 RTE_ETH_FOREACH_DEV(portid) {
2944 if ((enabled_port_mask & (1 << portid)) == 0)
2947 printf("Closing port %d...", portid);
2948 if (flow_info_tbl[portid].rx_def_flow) {
2949 struct rte_flow_error err;
2951 ret = rte_flow_destroy(portid,
2952 flow_info_tbl[portid].rx_def_flow, &err);
2954 RTE_LOG(ERR, IPSEC, "Failed to destroy flow "
2955 " for port %u, err msg: %s\n", portid,
2958 ret = rte_eth_dev_stop(portid);
2961 "rte_eth_dev_stop: err=%s, port=%u\n",
2962 rte_strerror(-ret), portid);
2964 rte_eth_dev_close(portid);
2968 /* clean up the EAL */