examples/ipsec-secgw: support security offload
[dpdk.git] / examples / ipsec-secgw / ipsec.c
index 36fb8c8..c24284d 100644 (file)
@@ -37,7 +37,9 @@
 #include <rte_branch_prediction.h>
 #include <rte_log.h>
 #include <rte_crypto.h>
+#include <rte_security.h>
 #include <rte_cryptodev.h>
+#include <rte_ethdev.h>
 #include <rte_mbuf.h>
 #include <rte_hash.h>
 
@@ -49,7 +51,7 @@ create_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa)
 {
        struct rte_cryptodev_info cdev_info;
        unsigned long cdev_id_qp = 0;
-       int32_t ret;
+       int32_t ret = 0;
        struct cdev_key key = { 0 };
 
        key.lcore_id = (uint8_t)rte_lcore_id();
@@ -58,16 +60,19 @@ create_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa)
        key.auth_algo = (uint8_t)sa->auth_algo;
        key.aead_algo = (uint8_t)sa->aead_algo;
 
-       ret = rte_hash_lookup_data(ipsec_ctx->cdev_map, &key,
-                       (void **)&cdev_id_qp);
-       if (ret < 0) {
-               RTE_LOG(ERR, IPSEC, "No cryptodev: core %u, cipher_algo %u, "
-                       "auth_algo %u, aead_algo %u\n",
-                       key.lcore_id,
-                       key.cipher_algo,
-                       key.auth_algo,
-                       key.aead_algo);
-               return -1;
+       if (sa->type == RTE_SECURITY_ACTION_TYPE_NONE) {
+               ret = rte_hash_lookup_data(ipsec_ctx->cdev_map, &key,
+                               (void **)&cdev_id_qp);
+               if (ret < 0) {
+                       RTE_LOG(ERR, IPSEC,
+                               "No cryptodev: core %u, cipher_algo %u, "
+                               "auth_algo %u, aead_algo %u\n",
+                               key.lcore_id,
+                               key.cipher_algo,
+                               key.auth_algo,
+                               key.aead_algo);
+                       return -1;
+               }
        }
 
        RTE_LOG_DP(DEBUG, IPSEC, "Create session for SA spi %u on cryptodev "
@@ -75,23 +80,153 @@ create_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa)
                        ipsec_ctx->tbl[cdev_id_qp].id,
                        ipsec_ctx->tbl[cdev_id_qp].qp);
 
-       sa->crypto_session = rte_cryptodev_sym_session_create(
-                       ipsec_ctx->session_pool);
-       rte_cryptodev_sym_session_init(ipsec_ctx->tbl[cdev_id_qp].id,
-                       sa->crypto_session, sa->xforms,
-                       ipsec_ctx->session_pool);
-
-       rte_cryptodev_info_get(ipsec_ctx->tbl[cdev_id_qp].id, &cdev_info);
-       if (cdev_info.sym.max_nb_sessions_per_qp > 0) {
-               ret = rte_cryptodev_queue_pair_attach_sym_session(
-                               ipsec_ctx->tbl[cdev_id_qp].id,
-                               ipsec_ctx->tbl[cdev_id_qp].qp,
-                               sa->crypto_session);
-               if (ret < 0) {
-                       RTE_LOG(ERR, IPSEC,
-                               "Session cannot be attached to qp %u ",
-                               ipsec_ctx->tbl[cdev_id_qp].qp);
-                       return -1;
+       if (sa->type != RTE_SECURITY_ACTION_TYPE_NONE) {
+               struct rte_security_session_conf sess_conf = {
+                       .action_type = sa->type,
+                       .protocol = RTE_SECURITY_PROTOCOL_IPSEC,
+                       .ipsec = {
+                               .spi = sa->spi,
+                               .salt = sa->salt,
+                               .options = { 0 },
+                               .direction = sa->direction,
+                               .proto = RTE_SECURITY_IPSEC_SA_PROTO_ESP,
+                               .mode = (sa->flags == IP4_TUNNEL ||
+                                               sa->flags == IP6_TUNNEL) ?
+                                       RTE_SECURITY_IPSEC_SA_MODE_TUNNEL :
+                                       RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT,
+                       },
+                       .crypto_xform = sa->xforms
+
+               };
+
+               if (sa->type == RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL) {
+                       struct rte_security_ctx *ctx = (struct rte_security_ctx *)
+                                                       rte_cryptodev_get_sec_ctx(
+                                                       ipsec_ctx->tbl[cdev_id_qp].id);
+
+                       if (sess_conf.ipsec.mode ==
+                                       RTE_SECURITY_IPSEC_SA_MODE_TUNNEL) {
+                               struct rte_security_ipsec_tunnel_param *tunnel =
+                                               &sess_conf.ipsec.tunnel;
+                               if (sa->flags == IP4_TUNNEL) {
+                                       tunnel->type =
+                                               RTE_SECURITY_IPSEC_TUNNEL_IPV4;
+                                       tunnel->ipv4.ttl = IPDEFTTL;
+
+                                       memcpy((uint8_t *)&tunnel->ipv4.src_ip,
+                                               (uint8_t *)&sa->src.ip.ip4, 4);
+
+                                       memcpy((uint8_t *)&tunnel->ipv4.dst_ip,
+                                               (uint8_t *)&sa->dst.ip.ip4, 4);
+                               }
+                               /* TODO support for Transport and IPV6 tunnel */
+                       }
+
+                       sa->sec_session = rte_security_session_create(ctx,
+                                       &sess_conf, ipsec_ctx->session_pool);
+                       if (sa->sec_session == NULL) {
+                               RTE_LOG(ERR, IPSEC,
+                               "SEC Session init failed: err: %d\n", ret);
+                               return -1;
+                       }
+               } else if (sa->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
+                       struct rte_flow_error err;
+                       struct rte_security_ctx *ctx = (struct rte_security_ctx *)
+                                                       rte_eth_dev_get_sec_ctx(
+                                                       sa->portid);
+                       const struct rte_security_capability *sec_cap;
+
+                       sa->sec_session = rte_security_session_create(ctx,
+                                       &sess_conf, ipsec_ctx->session_pool);
+                       if (sa->sec_session == NULL) {
+                               RTE_LOG(ERR, IPSEC,
+                               "SEC Session init failed: err: %d\n", ret);
+                               return -1;
+                       }
+
+                       sec_cap = rte_security_capabilities_get(ctx);
+
+                       /* iterate until ESP tunnel*/
+                       while (sec_cap->action !=
+                                       RTE_SECURITY_ACTION_TYPE_NONE) {
+
+                               if (sec_cap->action == sa->type &&
+                                   sec_cap->protocol ==
+                                       RTE_SECURITY_PROTOCOL_IPSEC &&
+                                   sec_cap->ipsec.mode ==
+                                       RTE_SECURITY_IPSEC_SA_MODE_TUNNEL &&
+                                   sec_cap->ipsec.direction == sa->direction)
+                                       break;
+                               sec_cap++;
+                       }
+
+                       if (sec_cap->action == RTE_SECURITY_ACTION_TYPE_NONE) {
+                               RTE_LOG(ERR, IPSEC,
+                               "No suitable security capability found\n");
+                               return -1;
+                       }
+
+                       sa->ol_flags = sec_cap->ol_flags;
+                       sa->security_ctx = ctx;
+                       sa->pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
+
+                       sa->pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV4;
+                       sa->pattern[1].mask = &rte_flow_item_ipv4_mask;
+                       if (sa->flags & IP6_TUNNEL) {
+                               sa->pattern[1].spec = &sa->ipv6_spec;
+                               memcpy(sa->ipv6_spec.hdr.dst_addr,
+                                       sa->dst.ip.ip6.ip6_b, 16);
+                               memcpy(sa->ipv6_spec.hdr.src_addr,
+                                      sa->src.ip.ip6.ip6_b, 16);
+                       } else {
+                               sa->pattern[1].spec = &sa->ipv4_spec;
+                               sa->ipv4_spec.hdr.dst_addr = sa->dst.ip.ip4;
+                               sa->ipv4_spec.hdr.src_addr = sa->src.ip.ip4;
+                       }
+
+                       sa->pattern[2].type = RTE_FLOW_ITEM_TYPE_ESP;
+                       sa->pattern[2].spec = &sa->esp_spec;
+                       sa->pattern[2].mask = &rte_flow_item_esp_mask;
+                       sa->esp_spec.hdr.spi = sa->spi;
+
+                       sa->pattern[3].type = RTE_FLOW_ITEM_TYPE_END;
+
+                       sa->action[0].type = RTE_FLOW_ACTION_TYPE_SECURITY;
+                       sa->action[0].conf = sa->sec_session;
+
+                       sa->action[1].type = RTE_FLOW_ACTION_TYPE_END;
+
+                       sa->attr.egress = (sa->direction ==
+                                       RTE_SECURITY_IPSEC_SA_DIR_EGRESS);
+                       sa->flow = rte_flow_create(sa->portid,
+                               &sa->attr, sa->pattern, sa->action, &err);
+                       if (sa->flow == NULL) {
+                               RTE_LOG(ERR, IPSEC,
+                                       "Failed to create ipsec flow msg: %s\n",
+                                       err.message);
+                               return -1;
+                       }
+               }
+       } else {
+               sa->crypto_session = rte_cryptodev_sym_session_create(
+                               ipsec_ctx->session_pool);
+               rte_cryptodev_sym_session_init(ipsec_ctx->tbl[cdev_id_qp].id,
+                               sa->crypto_session, sa->xforms,
+                               ipsec_ctx->session_pool);
+
+               rte_cryptodev_info_get(ipsec_ctx->tbl[cdev_id_qp].id,
+                               &cdev_info);
+               if (cdev_info.sym.max_nb_sessions_per_qp > 0) {
+                       ret = rte_cryptodev_queue_pair_attach_sym_session(
+                                       ipsec_ctx->tbl[cdev_id_qp].id,
+                                       ipsec_ctx->tbl[cdev_id_qp].qp,
+                                       sa->crypto_session);
+                       if (ret < 0) {
+                               RTE_LOG(ERR, IPSEC,
+                                       "Session cannot be attached to qp %u\n",
+                                       ipsec_ctx->tbl[cdev_id_qp].qp);
+                               return -1;
+                       }
                }
        }
        sa->cdev_id_qp = cdev_id_qp;
@@ -129,7 +264,9 @@ ipsec_enqueue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
 {
        int32_t ret = 0, i;
        struct ipsec_mbuf_metadata *priv;
+       struct rte_crypto_sym_op *sym_cop;
        struct ipsec_sa *sa;
+       struct cdev_qp *cqp;
 
        for (i = 0; i < nb_pkts; i++) {
                if (unlikely(sas[i] == NULL)) {
@@ -144,23 +281,76 @@ ipsec_enqueue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
                sa = sas[i];
                priv->sa = sa;
 
-               priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
-               priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
-
-               rte_prefetch0(&priv->sym_cop);
-
-               if ((unlikely(sa->crypto_session == NULL)) &&
-                               create_session(ipsec_ctx, sa)) {
-                       rte_pktmbuf_free(pkts[i]);
-                       continue;
-               }
-
-               rte_crypto_op_attach_sym_session(&priv->cop,
-                               sa->crypto_session);
-
-               ret = xform_func(pkts[i], sa, &priv->cop);
-               if (unlikely(ret)) {
-                       rte_pktmbuf_free(pkts[i]);
+               switch (sa->type) {
+               case RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL:
+                       priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
+                       priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
+
+                       rte_prefetch0(&priv->sym_cop);
+
+                       if ((unlikely(sa->sec_session == NULL)) &&
+                                       create_session(ipsec_ctx, sa)) {
+                               rte_pktmbuf_free(pkts[i]);
+                               continue;
+                       }
+
+                       sym_cop = get_sym_cop(&priv->cop);
+                       sym_cop->m_src = pkts[i];
+
+                       rte_security_attach_session(&priv->cop,
+                                       sa->sec_session);
+                       break;
+               case RTE_SECURITY_ACTION_TYPE_NONE:
+
+                       priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
+                       priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
+
+                       rte_prefetch0(&priv->sym_cop);
+
+                       if ((unlikely(sa->crypto_session == NULL)) &&
+                                       create_session(ipsec_ctx, sa)) {
+                               rte_pktmbuf_free(pkts[i]);
+                               continue;
+                       }
+
+                       rte_crypto_op_attach_sym_session(&priv->cop,
+                                       sa->crypto_session);
+
+                       ret = xform_func(pkts[i], sa, &priv->cop);
+                       if (unlikely(ret)) {
+                               rte_pktmbuf_free(pkts[i]);
+                               continue;
+                       }
+                       break;
+               case RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL:
+                       break;
+               case RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO:
+                       priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
+                       priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
+
+                       rte_prefetch0(&priv->sym_cop);
+
+                       if ((unlikely(sa->sec_session == NULL)) &&
+                                       create_session(ipsec_ctx, sa)) {
+                               rte_pktmbuf_free(pkts[i]);
+                               continue;
+                       }
+
+                       rte_security_attach_session(&priv->cop,
+                                       sa->sec_session);
+
+                       ret = xform_func(pkts[i], sa, &priv->cop);
+                       if (unlikely(ret)) {
+                               rte_pktmbuf_free(pkts[i]);
+                               continue;
+                       }
+
+                       cqp = &ipsec_ctx->tbl[sa->cdev_id_qp];
+                       cqp->ol_pkts[cqp->ol_pkts_cnt++] = pkts[i];
+                       if (sa->ol_flags & RTE_SECURITY_TX_OLOAD_NEED_MDATA)
+                               rte_security_set_pkt_metadata(
+                                               sa->security_ctx,
+                                               sa->sec_session, pkts[i], NULL);
                        continue;
                }
 
@@ -171,7 +361,7 @@ ipsec_enqueue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
 
 static inline int
 ipsec_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
-               struct rte_mbuf *pkts[], uint16_t max_pkts)
+             struct rte_mbuf *pkts[], uint16_t max_pkts)
 {
        int32_t nb_pkts = 0, ret = 0, i, j, nb_cops;
        struct ipsec_mbuf_metadata *priv;
@@ -186,6 +376,19 @@ ipsec_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
                if (ipsec_ctx->last_qp == ipsec_ctx->nb_qps)
                        ipsec_ctx->last_qp %= ipsec_ctx->nb_qps;
 
+               while (cqp->ol_pkts_cnt > 0 && nb_pkts < max_pkts) {
+                       pkt = cqp->ol_pkts[--cqp->ol_pkts_cnt];
+                       rte_prefetch0(pkt);
+                       priv = get_priv(pkt);
+                       sa = priv->sa;
+                       ret = xform_func(pkt, sa, &priv->cop);
+                       if (unlikely(ret)) {
+                               rte_pktmbuf_free(pkt);
+                               continue;
+                       }
+                       pkts[nb_pkts++] = pkt;
+               }
+
                if (cqp->in_flight == 0)
                        continue;
 
@@ -203,11 +406,14 @@ ipsec_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
 
                        RTE_ASSERT(sa != NULL);
 
-                       ret = xform_func(pkt, sa, cops[j]);
-                       if (unlikely(ret))
-                               rte_pktmbuf_free(pkt);
-                       else
-                               pkts[nb_pkts++] = pkt;
+                       if (sa->type == RTE_SECURITY_ACTION_TYPE_NONE) {
+                               ret = xform_func(pkt, sa, cops[j]);
+                               if (unlikely(ret)) {
+                                       rte_pktmbuf_free(pkt);
+                                       continue;
+                               }
+                       }
+                       pkts[nb_pkts++] = pkt;
                }
        }