1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2017 Intel Corporation
5 #include <netinet/in.h>
6 #include <netinet/ip.h>
8 #include <rte_branch_prediction.h>
10 #include <rte_crypto.h>
11 #include <rte_security.h>
12 #include <rte_cryptodev.h>
13 #include <rte_ethdev.h>
21 set_ipsec_conf(struct ipsec_sa *sa, struct rte_security_ipsec_xform *ipsec)
23 if (ipsec->mode == RTE_SECURITY_IPSEC_SA_MODE_TUNNEL) {
24 struct rte_security_ipsec_tunnel_param *tunnel =
26 if (IS_IP4_TUNNEL(sa->flags)) {
28 RTE_SECURITY_IPSEC_TUNNEL_IPV4;
29 tunnel->ipv4.ttl = IPDEFTTL;
31 memcpy((uint8_t *)&tunnel->ipv4.src_ip,
32 (uint8_t *)&sa->src.ip.ip4, 4);
34 memcpy((uint8_t *)&tunnel->ipv4.dst_ip,
35 (uint8_t *)&sa->dst.ip.ip4, 4);
37 /* TODO support for Transport and IPV6 tunnel */
39 ipsec->esn_soft_limit = IPSEC_OFFLOAD_ESN_SOFTLIMIT;
43 create_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa)
45 struct rte_cryptodev_info cdev_info;
46 unsigned long cdev_id_qp = 0;
48 struct cdev_key key = { 0 };
50 key.lcore_id = (uint8_t)rte_lcore_id();
52 key.cipher_algo = (uint8_t)sa->cipher_algo;
53 key.auth_algo = (uint8_t)sa->auth_algo;
54 key.aead_algo = (uint8_t)sa->aead_algo;
56 if (sa->type == RTE_SECURITY_ACTION_TYPE_NONE) {
57 ret = rte_hash_lookup_data(ipsec_ctx->cdev_map, &key,
58 (void **)&cdev_id_qp);
61 "No cryptodev: core %u, cipher_algo %u, "
62 "auth_algo %u, aead_algo %u\n",
71 RTE_LOG_DP(DEBUG, IPSEC, "Create session for SA spi %u on cryptodev "
72 "%u qp %u\n", sa->spi,
73 ipsec_ctx->tbl[cdev_id_qp].id,
74 ipsec_ctx->tbl[cdev_id_qp].qp);
76 if (sa->type != RTE_SECURITY_ACTION_TYPE_NONE) {
77 struct rte_security_session_conf sess_conf = {
78 .action_type = sa->type,
79 .protocol = RTE_SECURITY_PROTOCOL_IPSEC,
84 .direction = sa->direction,
85 .proto = RTE_SECURITY_IPSEC_SA_PROTO_ESP,
86 .mode = (IS_TUNNEL(sa->flags)) ?
87 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL :
88 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT,
90 .crypto_xform = sa->xforms,
95 if (sa->type == RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL) {
96 struct rte_security_ctx *ctx = (struct rte_security_ctx *)
97 rte_cryptodev_get_sec_ctx(
98 ipsec_ctx->tbl[cdev_id_qp].id);
100 /* Set IPsec parameters in conf */
101 set_ipsec_conf(sa, &(sess_conf.ipsec));
103 sa->sec_session = rte_security_session_create(ctx,
104 &sess_conf, ipsec_ctx->session_priv_pool);
105 if (sa->sec_session == NULL) {
107 "SEC Session init failed: err: %d\n", ret);
110 } else if (sa->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
111 struct rte_flow_error err;
112 struct rte_security_ctx *ctx = (struct rte_security_ctx *)
113 rte_eth_dev_get_sec_ctx(
115 const struct rte_security_capability *sec_cap;
118 sa->sec_session = rte_security_session_create(ctx,
119 &sess_conf, ipsec_ctx->session_priv_pool);
120 if (sa->sec_session == NULL) {
122 "SEC Session init failed: err: %d\n", ret);
126 sec_cap = rte_security_capabilities_get(ctx);
128 /* iterate until ESP tunnel*/
129 while (sec_cap->action !=
130 RTE_SECURITY_ACTION_TYPE_NONE) {
132 if (sec_cap->action == sa->type &&
134 RTE_SECURITY_PROTOCOL_IPSEC &&
135 sec_cap->ipsec.mode ==
136 sess_conf.ipsec.mode &&
137 sec_cap->ipsec.direction == sa->direction)
142 if (sec_cap->action == RTE_SECURITY_ACTION_TYPE_NONE) {
144 "No suitable security capability found\n");
148 sa->ol_flags = sec_cap->ol_flags;
149 sa->security_ctx = ctx;
150 sa->pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
152 if (IS_IP6(sa->flags)) {
153 sa->pattern[1].mask = &rte_flow_item_ipv6_mask;
154 sa->pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV6;
155 sa->pattern[1].spec = &sa->ipv6_spec;
157 memcpy(sa->ipv6_spec.hdr.dst_addr,
158 sa->dst.ip.ip6.ip6_b, 16);
159 memcpy(sa->ipv6_spec.hdr.src_addr,
160 sa->src.ip.ip6.ip6_b, 16);
161 } else if (IS_IP4(sa->flags)) {
162 sa->pattern[1].mask = &rte_flow_item_ipv4_mask;
163 sa->pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV4;
164 sa->pattern[1].spec = &sa->ipv4_spec;
166 sa->ipv4_spec.hdr.dst_addr = sa->dst.ip.ip4;
167 sa->ipv4_spec.hdr.src_addr = sa->src.ip.ip4;
170 sa->pattern[2].type = RTE_FLOW_ITEM_TYPE_ESP;
171 sa->pattern[2].spec = &sa->esp_spec;
172 sa->pattern[2].mask = &rte_flow_item_esp_mask;
173 sa->esp_spec.hdr.spi = rte_cpu_to_be_32(sa->spi);
175 sa->pattern[3].type = RTE_FLOW_ITEM_TYPE_END;
177 sa->action[0].type = RTE_FLOW_ACTION_TYPE_SECURITY;
178 sa->action[0].conf = sa->sec_session;
180 sa->action[1].type = RTE_FLOW_ACTION_TYPE_END;
182 sa->attr.egress = (sa->direction ==
183 RTE_SECURITY_IPSEC_SA_DIR_EGRESS);
184 sa->attr.ingress = (sa->direction ==
185 RTE_SECURITY_IPSEC_SA_DIR_INGRESS);
186 if (sa->attr.ingress) {
188 struct rte_eth_rss_conf rss_conf = {
192 struct rte_eth_dev *eth_dev;
193 uint16_t queue[RTE_MAX_QUEUES_PER_PORT];
194 struct rte_flow_action_rss action_rss;
198 sa->action[2].type = RTE_FLOW_ACTION_TYPE_END;
200 sa->action[1].type = RTE_FLOW_ACTION_TYPE_RSS;
201 sa->action[1].conf = &action_rss;
202 eth_dev = ctx->device;
203 rte_eth_dev_rss_hash_conf_get(sa->portid,
206 i < eth_dev->data->nb_rx_queues; ++i)
207 if (eth_dev->data->rx_queues[i])
209 action_rss = (struct rte_flow_action_rss){
210 .types = rss_conf.rss_hf,
211 .key_len = rss_conf.rss_key_len,
216 ret = rte_flow_validate(sa->portid, &sa->attr,
217 sa->pattern, sa->action,
222 sa->action[1].type = RTE_FLOW_ACTION_TYPE_QUEUE;
224 &(struct rte_flow_action_queue){
227 ret = rte_flow_validate(sa->portid, &sa->attr,
228 sa->pattern, sa->action,
231 sa->action[1].type = RTE_FLOW_ACTION_TYPE_END;
232 sa->action[1].conf = NULL;
233 ret = rte_flow_validate(sa->portid, &sa->attr,
234 sa->pattern, sa->action,
237 goto flow_create_failure;
238 } else if (sa->attr.egress &&
240 RTE_SECURITY_TX_HW_TRAILER_OFFLOAD)) {
242 RTE_FLOW_ACTION_TYPE_PASSTHRU;
244 RTE_FLOW_ACTION_TYPE_END;
247 sa->flow = rte_flow_create(sa->portid,
248 &sa->attr, sa->pattern, sa->action, &err);
249 if (sa->flow == NULL) {
252 "Failed to create ipsec flow msg: %s\n",
256 } else if (sa->type ==
257 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL) {
258 struct rte_security_ctx *ctx =
259 (struct rte_security_ctx *)
260 rte_eth_dev_get_sec_ctx(sa->portid);
261 const struct rte_security_capability *sec_cap;
265 "Ethernet device doesn't have security features registered\n");
269 /* Set IPsec parameters in conf */
270 set_ipsec_conf(sa, &(sess_conf.ipsec));
272 /* Save SA as userdata for the security session. When
273 * the packet is received, this userdata will be
274 * retrieved using the metadata from the packet.
276 * The PMD is expected to set similar metadata for other
277 * operations, like rte_eth_event, which are tied to
278 * security session. In such cases, the userdata could
279 * be obtained to uniquely identify the security
280 * parameters denoted.
283 sess_conf.userdata = (void *) sa;
285 sa->sec_session = rte_security_session_create(ctx,
286 &sess_conf, ipsec_ctx->session_pool);
287 if (sa->sec_session == NULL) {
289 "SEC Session init failed: err: %d\n", ret);
293 sec_cap = rte_security_capabilities_get(ctx);
295 if (sec_cap == NULL) {
297 "No capabilities registered\n");
301 /* iterate until ESP tunnel*/
302 while (sec_cap->action !=
303 RTE_SECURITY_ACTION_TYPE_NONE) {
305 if (sec_cap->action == sa->type &&
307 RTE_SECURITY_PROTOCOL_IPSEC &&
308 sec_cap->ipsec.mode ==
309 sess_conf.ipsec.mode &&
310 sec_cap->ipsec.direction == sa->direction)
315 if (sec_cap->action == RTE_SECURITY_ACTION_TYPE_NONE) {
317 "No suitable security capability found\n");
321 sa->ol_flags = sec_cap->ol_flags;
322 sa->security_ctx = ctx;
325 sa->crypto_session = rte_cryptodev_sym_session_create(
326 ipsec_ctx->session_pool);
327 rte_cryptodev_sym_session_init(ipsec_ctx->tbl[cdev_id_qp].id,
328 sa->crypto_session, sa->xforms,
329 ipsec_ctx->session_priv_pool);
331 rte_cryptodev_info_get(ipsec_ctx->tbl[cdev_id_qp].id,
334 sa->cdev_id_qp = cdev_id_qp;
340 * queue crypto-ops into PMD queue.
343 enqueue_cop_burst(struct cdev_qp *cqp)
345 uint32_t i, len, ret;
348 ret = rte_cryptodev_enqueue_burst(cqp->id, cqp->qp, cqp->buf, len);
350 RTE_LOG_DP(DEBUG, IPSEC, "Cryptodev %u queue %u:"
351 " enqueued %u crypto ops out of %u\n",
352 cqp->id, cqp->qp, ret, len);
353 /* drop packets that we fail to enqueue */
354 for (i = ret; i < len; i++)
355 rte_pktmbuf_free(cqp->buf[i]->sym->m_src);
357 cqp->in_flight += ret;
362 enqueue_cop(struct cdev_qp *cqp, struct rte_crypto_op *cop)
364 cqp->buf[cqp->len++] = cop;
366 if (cqp->len == MAX_PKT_BURST)
367 enqueue_cop_burst(cqp);
371 ipsec_enqueue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
372 struct rte_mbuf *pkts[], struct ipsec_sa *sas[],
376 struct ipsec_mbuf_metadata *priv;
377 struct rte_crypto_sym_op *sym_cop;
380 for (i = 0; i < nb_pkts; i++) {
381 if (unlikely(sas[i] == NULL)) {
382 rte_pktmbuf_free(pkts[i]);
386 rte_prefetch0(sas[i]);
387 rte_prefetch0(pkts[i]);
389 priv = get_priv(pkts[i]);
394 case RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL:
395 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
396 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
398 rte_prefetch0(&priv->sym_cop);
400 if ((unlikely(sa->sec_session == NULL)) &&
401 create_session(ipsec_ctx, sa)) {
402 rte_pktmbuf_free(pkts[i]);
406 sym_cop = get_sym_cop(&priv->cop);
407 sym_cop->m_src = pkts[i];
409 rte_security_attach_session(&priv->cop,
412 case RTE_SECURITY_ACTION_TYPE_NONE:
414 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
415 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
417 rte_prefetch0(&priv->sym_cop);
419 if ((unlikely(sa->crypto_session == NULL)) &&
420 create_session(ipsec_ctx, sa)) {
421 rte_pktmbuf_free(pkts[i]);
425 rte_crypto_op_attach_sym_session(&priv->cop,
428 ret = xform_func(pkts[i], sa, &priv->cop);
430 rte_pktmbuf_free(pkts[i]);
434 case RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL:
435 if ((unlikely(sa->sec_session == NULL)) &&
436 create_session(ipsec_ctx, sa)) {
437 rte_pktmbuf_free(pkts[i]);
441 ipsec_ctx->ol_pkts[ipsec_ctx->ol_pkts_cnt++] = pkts[i];
442 if (sa->ol_flags & RTE_SECURITY_TX_OLOAD_NEED_MDATA)
443 rte_security_set_pkt_metadata(
445 sa->sec_session, pkts[i], NULL);
447 case RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO:
448 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
449 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
451 rte_prefetch0(&priv->sym_cop);
453 if ((unlikely(sa->sec_session == NULL)) &&
454 create_session(ipsec_ctx, sa)) {
455 rte_pktmbuf_free(pkts[i]);
459 rte_security_attach_session(&priv->cop,
462 ret = xform_func(pkts[i], sa, &priv->cop);
464 rte_pktmbuf_free(pkts[i]);
468 ipsec_ctx->ol_pkts[ipsec_ctx->ol_pkts_cnt++] = pkts[i];
469 if (sa->ol_flags & RTE_SECURITY_TX_OLOAD_NEED_MDATA)
470 rte_security_set_pkt_metadata(
472 sa->sec_session, pkts[i], NULL);
476 RTE_ASSERT(sa->cdev_id_qp < ipsec_ctx->nb_qps);
477 enqueue_cop(&ipsec_ctx->tbl[sa->cdev_id_qp], &priv->cop);
481 static inline int32_t
482 ipsec_inline_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
483 struct rte_mbuf *pkts[], uint16_t max_pkts)
485 int32_t nb_pkts, ret;
486 struct ipsec_mbuf_metadata *priv;
488 struct rte_mbuf *pkt;
491 while (ipsec_ctx->ol_pkts_cnt > 0 && nb_pkts < max_pkts) {
492 pkt = ipsec_ctx->ol_pkts[--ipsec_ctx->ol_pkts_cnt];
494 priv = get_priv(pkt);
496 ret = xform_func(pkt, sa, &priv->cop);
498 rte_pktmbuf_free(pkt);
501 pkts[nb_pkts++] = pkt;
508 ipsec_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
509 struct rte_mbuf *pkts[], uint16_t max_pkts)
511 int32_t nb_pkts = 0, ret = 0, i, j, nb_cops;
512 struct ipsec_mbuf_metadata *priv;
513 struct rte_crypto_op *cops[max_pkts];
515 struct rte_mbuf *pkt;
517 for (i = 0; i < ipsec_ctx->nb_qps && nb_pkts < max_pkts; i++) {
520 cqp = &ipsec_ctx->tbl[ipsec_ctx->last_qp++];
521 if (ipsec_ctx->last_qp == ipsec_ctx->nb_qps)
522 ipsec_ctx->last_qp %= ipsec_ctx->nb_qps;
524 if (cqp->in_flight == 0)
527 nb_cops = rte_cryptodev_dequeue_burst(cqp->id, cqp->qp,
528 cops, max_pkts - nb_pkts);
530 cqp->in_flight -= nb_cops;
532 for (j = 0; j < nb_cops; j++) {
533 pkt = cops[j]->sym->m_src;
536 priv = get_priv(pkt);
539 RTE_ASSERT(sa != NULL);
541 if (sa->type == RTE_SECURITY_ACTION_TYPE_NONE) {
542 ret = xform_func(pkt, sa, cops[j]);
544 rte_pktmbuf_free(pkt);
548 pkts[nb_pkts++] = pkt;
557 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
558 uint16_t nb_pkts, uint16_t len)
560 struct ipsec_sa *sas[nb_pkts];
562 inbound_sa_lookup(ctx->sa_ctx, pkts, sas, nb_pkts);
564 ipsec_enqueue(esp_inbound, ctx, pkts, sas, nb_pkts);
566 return ipsec_inline_dequeue(esp_inbound_post, ctx, pkts, len);
570 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
573 return ipsec_dequeue(esp_inbound_post, ctx, pkts, len);
577 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
578 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len)
580 struct ipsec_sa *sas[nb_pkts];
582 outbound_sa_lookup(ctx->sa_ctx, sa_idx, sas, nb_pkts);
584 ipsec_enqueue(esp_outbound, ctx, pkts, sas, nb_pkts);
586 return ipsec_inline_dequeue(esp_outbound_post, ctx, pkts, len);
590 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
593 return ipsec_dequeue(esp_outbound_post, ctx, pkts, len);