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_lookaside_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 ret = rte_hash_lookup_data(ipsec_ctx->cdev_map, &key,
57 (void **)&cdev_id_qp);
60 "No cryptodev: core %u, cipher_algo %u, "
61 "auth_algo %u, aead_algo %u\n",
69 RTE_LOG_DP(DEBUG, IPSEC, "Create session for SA spi %u on cryptodev "
70 "%u qp %u\n", sa->spi,
71 ipsec_ctx->tbl[cdev_id_qp].id,
72 ipsec_ctx->tbl[cdev_id_qp].qp);
74 if (sa->type != RTE_SECURITY_ACTION_TYPE_NONE) {
75 struct rte_security_session_conf sess_conf = {
76 .action_type = sa->type,
77 .protocol = RTE_SECURITY_PROTOCOL_IPSEC,
82 .direction = sa->direction,
83 .proto = RTE_SECURITY_IPSEC_SA_PROTO_ESP,
84 .mode = (IS_TUNNEL(sa->flags)) ?
85 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL :
86 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT,
88 .crypto_xform = sa->xforms,
93 if (sa->type == RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL) {
94 struct rte_security_ctx *ctx = (struct rte_security_ctx *)
95 rte_cryptodev_get_sec_ctx(
96 ipsec_ctx->tbl[cdev_id_qp].id);
98 /* Set IPsec parameters in conf */
99 set_ipsec_conf(sa, &(sess_conf.ipsec));
101 sa->sec_session = rte_security_session_create(ctx,
102 &sess_conf, ipsec_ctx->session_priv_pool);
103 if (sa->sec_session == NULL) {
105 "SEC Session init failed: err: %d\n", ret);
109 RTE_LOG(ERR, IPSEC, "Inline not supported\n");
113 sa->crypto_session = rte_cryptodev_sym_session_create(
114 ipsec_ctx->session_pool);
115 rte_cryptodev_sym_session_init(ipsec_ctx->tbl[cdev_id_qp].id,
116 sa->crypto_session, sa->xforms,
117 ipsec_ctx->session_priv_pool);
119 rte_cryptodev_info_get(ipsec_ctx->tbl[cdev_id_qp].id,
123 sa->cdev_id_qp = cdev_id_qp;
129 create_inline_session(struct socket_ctx *skt_ctx, struct ipsec_sa *sa)
132 struct rte_security_ctx *sec_ctx;
133 struct rte_security_session_conf sess_conf = {
134 .action_type = sa->type,
135 .protocol = RTE_SECURITY_PROTOCOL_IPSEC,
140 .direction = sa->direction,
141 .proto = RTE_SECURITY_IPSEC_SA_PROTO_ESP,
142 .mode = (sa->flags == IP4_TUNNEL ||
143 sa->flags == IP6_TUNNEL) ?
144 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL :
145 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT,
147 .crypto_xform = sa->xforms,
151 RTE_LOG_DP(DEBUG, IPSEC, "Create session for SA spi %u on port %u\n",
152 sa->spi, sa->portid);
154 if (sa->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
155 struct rte_flow_error err;
156 const struct rte_security_capability *sec_cap;
159 sec_ctx = (struct rte_security_ctx *)
160 rte_eth_dev_get_sec_ctx(
162 if (sec_ctx == NULL) {
164 " rte_eth_dev_get_sec_ctx failed\n");
168 sa->sec_session = rte_security_session_create(sec_ctx,
169 &sess_conf, skt_ctx->session_pool);
170 if (sa->sec_session == NULL) {
172 "SEC Session init failed: err: %d\n", ret);
176 sec_cap = rte_security_capabilities_get(sec_ctx);
178 /* iterate until ESP tunnel*/
179 while (sec_cap->action != RTE_SECURITY_ACTION_TYPE_NONE) {
180 if (sec_cap->action == sa->type &&
182 RTE_SECURITY_PROTOCOL_IPSEC &&
183 sec_cap->ipsec.mode ==
184 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL &&
185 sec_cap->ipsec.direction == sa->direction)
190 if (sec_cap->action == RTE_SECURITY_ACTION_TYPE_NONE) {
192 "No suitable security capability found\n");
196 sa->ol_flags = sec_cap->ol_flags;
197 sa->security_ctx = sec_ctx;
198 sa->pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
200 if (IS_IP6(sa->flags)) {
201 sa->pattern[1].mask = &rte_flow_item_ipv6_mask;
202 sa->pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV6;
203 sa->pattern[1].spec = &sa->ipv6_spec;
205 memcpy(sa->ipv6_spec.hdr.dst_addr,
206 sa->dst.ip.ip6.ip6_b, 16);
207 memcpy(sa->ipv6_spec.hdr.src_addr,
208 sa->src.ip.ip6.ip6_b, 16);
209 } else if (IS_IP4(sa->flags)) {
210 sa->pattern[1].mask = &rte_flow_item_ipv4_mask;
211 sa->pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV4;
212 sa->pattern[1].spec = &sa->ipv4_spec;
214 sa->ipv4_spec.hdr.dst_addr = sa->dst.ip.ip4;
215 sa->ipv4_spec.hdr.src_addr = sa->src.ip.ip4;
218 sa->pattern[2].type = RTE_FLOW_ITEM_TYPE_ESP;
219 sa->pattern[2].spec = &sa->esp_spec;
220 sa->pattern[2].mask = &rte_flow_item_esp_mask;
221 sa->esp_spec.hdr.spi = rte_cpu_to_be_32(sa->spi);
223 sa->pattern[3].type = RTE_FLOW_ITEM_TYPE_END;
225 sa->action[0].type = RTE_FLOW_ACTION_TYPE_SECURITY;
226 sa->action[0].conf = sa->sec_session;
228 sa->action[1].type = RTE_FLOW_ACTION_TYPE_END;
230 sa->attr.egress = (sa->direction ==
231 RTE_SECURITY_IPSEC_SA_DIR_EGRESS);
232 sa->attr.ingress = (sa->direction ==
233 RTE_SECURITY_IPSEC_SA_DIR_INGRESS);
234 if (sa->attr.ingress) {
236 struct rte_eth_rss_conf rss_conf = {
240 struct rte_eth_dev_info dev_info;
241 uint16_t queue[RTE_MAX_QUEUES_PER_PORT];
242 struct rte_flow_action_rss action_rss;
246 rte_eth_dev_info_get(sa->portid, &dev_info);
247 sa->action[2].type = RTE_FLOW_ACTION_TYPE_END;
249 sa->action[1].type = RTE_FLOW_ACTION_TYPE_RSS;
250 sa->action[1].conf = &action_rss;
251 ret = rte_eth_dev_rss_hash_conf_get(sa->portid,
255 "rte_eth_dev_rss_hash_conf_get:ret=%d\n",
259 for (i = 0, j = 0; i < dev_info.nb_rx_queues; ++i)
262 action_rss = (struct rte_flow_action_rss){
263 .types = rss_conf.rss_hf,
264 .key_len = rss_conf.rss_key_len,
269 ret = rte_flow_validate(sa->portid, &sa->attr,
270 sa->pattern, sa->action,
275 sa->action[1].type = RTE_FLOW_ACTION_TYPE_QUEUE;
277 &(struct rte_flow_action_queue){
280 ret = rte_flow_validate(sa->portid, &sa->attr,
281 sa->pattern, sa->action,
284 sa->action[1].type = RTE_FLOW_ACTION_TYPE_END;
285 sa->action[1].conf = NULL;
286 ret = rte_flow_validate(sa->portid, &sa->attr,
287 sa->pattern, sa->action,
290 goto flow_create_failure;
291 } else if (sa->attr.egress &&
293 RTE_SECURITY_TX_HW_TRAILER_OFFLOAD)) {
295 RTE_FLOW_ACTION_TYPE_PASSTHRU;
297 RTE_FLOW_ACTION_TYPE_END;
300 sa->flow = rte_flow_create(sa->portid,
301 &sa->attr, sa->pattern, sa->action, &err);
302 if (sa->flow == NULL) {
305 "Failed to create ipsec flow msg: %s\n",
309 } else if (sa->type == RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL) {
310 const struct rte_security_capability *sec_cap;
312 sec_ctx = (struct rte_security_ctx *)
313 rte_eth_dev_get_sec_ctx(sa->portid);
315 if (sec_ctx == NULL) {
317 "Ethernet device doesn't have security features registered\n");
321 /* Set IPsec parameters in conf */
322 set_ipsec_conf(sa, &(sess_conf.ipsec));
324 /* Save SA as userdata for the security session. When
325 * the packet is received, this userdata will be
326 * retrieved using the metadata from the packet.
328 * The PMD is expected to set similar metadata for other
329 * operations, like rte_eth_event, which are tied to
330 * security session. In such cases, the userdata could
331 * be obtained to uniquely identify the security
332 * parameters denoted.
335 sess_conf.userdata = (void *) sa;
337 sa->sec_session = rte_security_session_create(sec_ctx,
338 &sess_conf, skt_ctx->session_pool);
339 if (sa->sec_session == NULL) {
341 "SEC Session init failed: err: %d\n", ret);
345 sec_cap = rte_security_capabilities_get(sec_ctx);
346 if (sec_cap == NULL) {
348 "No capabilities registered\n");
352 /* iterate until ESP tunnel*/
353 while (sec_cap->action !=
354 RTE_SECURITY_ACTION_TYPE_NONE) {
355 if (sec_cap->action == sa->type &&
357 RTE_SECURITY_PROTOCOL_IPSEC &&
358 sec_cap->ipsec.mode ==
359 sess_conf.ipsec.mode &&
360 sec_cap->ipsec.direction == sa->direction)
365 if (sec_cap->action == RTE_SECURITY_ACTION_TYPE_NONE) {
367 "No suitable security capability found\n");
371 sa->ol_flags = sec_cap->ol_flags;
372 sa->security_ctx = sec_ctx;
380 * queue crypto-ops into PMD queue.
383 enqueue_cop_burst(struct cdev_qp *cqp)
385 uint32_t i, len, ret;
388 ret = rte_cryptodev_enqueue_burst(cqp->id, cqp->qp, cqp->buf, len);
390 RTE_LOG_DP(DEBUG, IPSEC, "Cryptodev %u queue %u:"
391 " enqueued %u crypto ops out of %u\n",
392 cqp->id, cqp->qp, ret, len);
393 /* drop packets that we fail to enqueue */
394 for (i = ret; i < len; i++)
395 rte_pktmbuf_free(cqp->buf[i]->sym->m_src);
397 cqp->in_flight += ret;
402 enqueue_cop(struct cdev_qp *cqp, struct rte_crypto_op *cop)
404 cqp->buf[cqp->len++] = cop;
406 if (cqp->len == MAX_PKT_BURST)
407 enqueue_cop_burst(cqp);
411 ipsec_enqueue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
412 struct rte_mbuf *pkts[], struct ipsec_sa *sas[],
416 struct ipsec_mbuf_metadata *priv;
417 struct rte_crypto_sym_op *sym_cop;
420 for (i = 0; i < nb_pkts; i++) {
421 if (unlikely(sas[i] == NULL)) {
422 rte_pktmbuf_free(pkts[i]);
426 rte_prefetch0(sas[i]);
427 rte_prefetch0(pkts[i]);
429 priv = get_priv(pkts[i]);
434 case RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL:
435 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
436 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
438 rte_prefetch0(&priv->sym_cop);
440 if ((unlikely(sa->sec_session == NULL)) &&
441 create_lookaside_session(ipsec_ctx, sa)) {
442 rte_pktmbuf_free(pkts[i]);
446 sym_cop = get_sym_cop(&priv->cop);
447 sym_cop->m_src = pkts[i];
449 rte_security_attach_session(&priv->cop,
452 case RTE_SECURITY_ACTION_TYPE_NONE:
454 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
455 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
457 rte_prefetch0(&priv->sym_cop);
459 if ((unlikely(sa->crypto_session == NULL)) &&
460 create_lookaside_session(ipsec_ctx, sa)) {
461 rte_pktmbuf_free(pkts[i]);
465 rte_crypto_op_attach_sym_session(&priv->cop,
468 ret = xform_func(pkts[i], sa, &priv->cop);
470 rte_pktmbuf_free(pkts[i]);
474 case RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL:
475 RTE_ASSERT(sa->sec_session != NULL);
476 ipsec_ctx->ol_pkts[ipsec_ctx->ol_pkts_cnt++] = pkts[i];
477 if (sa->ol_flags & RTE_SECURITY_TX_OLOAD_NEED_MDATA)
478 rte_security_set_pkt_metadata(
480 sa->sec_session, pkts[i], NULL);
482 case RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO:
483 RTE_ASSERT(sa->sec_session != NULL);
484 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
485 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
487 rte_prefetch0(&priv->sym_cop);
488 rte_security_attach_session(&priv->cop,
491 ret = xform_func(pkts[i], sa, &priv->cop);
493 rte_pktmbuf_free(pkts[i]);
497 ipsec_ctx->ol_pkts[ipsec_ctx->ol_pkts_cnt++] = pkts[i];
498 if (sa->ol_flags & RTE_SECURITY_TX_OLOAD_NEED_MDATA)
499 rte_security_set_pkt_metadata(
501 sa->sec_session, pkts[i], NULL);
505 RTE_ASSERT(sa->cdev_id_qp < ipsec_ctx->nb_qps);
506 enqueue_cop(&ipsec_ctx->tbl[sa->cdev_id_qp], &priv->cop);
510 static inline int32_t
511 ipsec_inline_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
512 struct rte_mbuf *pkts[], uint16_t max_pkts)
514 int32_t nb_pkts, ret;
515 struct ipsec_mbuf_metadata *priv;
517 struct rte_mbuf *pkt;
520 while (ipsec_ctx->ol_pkts_cnt > 0 && nb_pkts < max_pkts) {
521 pkt = ipsec_ctx->ol_pkts[--ipsec_ctx->ol_pkts_cnt];
523 priv = get_priv(pkt);
525 ret = xform_func(pkt, sa, &priv->cop);
527 rte_pktmbuf_free(pkt);
530 pkts[nb_pkts++] = pkt;
537 ipsec_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
538 struct rte_mbuf *pkts[], uint16_t max_pkts)
540 int32_t nb_pkts = 0, ret = 0, i, j, nb_cops;
541 struct ipsec_mbuf_metadata *priv;
542 struct rte_crypto_op *cops[max_pkts];
544 struct rte_mbuf *pkt;
546 for (i = 0; i < ipsec_ctx->nb_qps && nb_pkts < max_pkts; i++) {
549 cqp = &ipsec_ctx->tbl[ipsec_ctx->last_qp++];
550 if (ipsec_ctx->last_qp == ipsec_ctx->nb_qps)
551 ipsec_ctx->last_qp %= ipsec_ctx->nb_qps;
553 if (cqp->in_flight == 0)
556 nb_cops = rte_cryptodev_dequeue_burst(cqp->id, cqp->qp,
557 cops, max_pkts - nb_pkts);
559 cqp->in_flight -= nb_cops;
561 for (j = 0; j < nb_cops; j++) {
562 pkt = cops[j]->sym->m_src;
565 priv = get_priv(pkt);
568 RTE_ASSERT(sa != NULL);
570 if (sa->type == RTE_SECURITY_ACTION_TYPE_NONE) {
571 ret = xform_func(pkt, sa, cops[j]);
573 rte_pktmbuf_free(pkt);
577 pkts[nb_pkts++] = pkt;
586 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
587 uint16_t nb_pkts, uint16_t len)
589 struct ipsec_sa *sas[nb_pkts];
591 inbound_sa_lookup(ctx->sa_ctx, pkts, sas, nb_pkts);
593 ipsec_enqueue(esp_inbound, ctx, pkts, sas, nb_pkts);
595 return ipsec_inline_dequeue(esp_inbound_post, ctx, pkts, len);
599 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
602 return ipsec_dequeue(esp_inbound_post, ctx, pkts, len);
606 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
607 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len)
609 struct ipsec_sa *sas[nb_pkts];
611 outbound_sa_lookup(ctx->sa_ctx, sa_idx, sas, nb_pkts);
613 ipsec_enqueue(esp_outbound, ctx, pkts, sas, nb_pkts);
615 return ipsec_inline_dequeue(esp_outbound_post, ctx, pkts, len);
619 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
622 return ipsec_dequeue(esp_outbound_post, ctx, pkts, len);