examples/ipsec-secgw: support 192/256 AES key sizes
[dpdk.git] / examples / ipsec-secgw / ipsec.h
index ccd0aa8..2fc60ff 100644 (file)
@@ -1,34 +1,5 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2016-2017 Intel Corporation
  */
 
 #ifndef __IPSEC_H__
 
 #include <rte_byteorder.h>
 #include <rte_crypto.h>
+#include <rte_security.h>
+#include <rte_flow.h>
+#include <rte_ipsec.h>
+
+#include "ipsec-secgw.h"
 
-#define RTE_LOGTYPE_IPSEC       RTE_LOGTYPE_USER1
 #define RTE_LOGTYPE_IPSEC_ESP   RTE_LOGTYPE_USER2
 #define RTE_LOGTYPE_IPSEC_IPIP  RTE_LOGTYPE_USER3
 
-#define MAX_PKT_BURST 32
+#define MAX_INFLIGHT 128
 #define MAX_QP_PER_LCORE 256
 
 #define MAX_DIGEST_SIZE 32 /* Bytes -- 256 bits */
 
+#define IPSEC_OFFLOAD_ESN_SOFTLIMIT 0xffffff00
+
 #define IV_OFFSET              (sizeof(struct rte_crypto_op) + \
                                sizeof(struct rte_crypto_sym_op))
 
 
 #define DEFAULT_MAX_CATEGORIES 1
 
-#define IPSEC_SA_MAX_ENTRIES (128) /* must be power of 2, max 2 power 30 */
-#define SPI2IDX(spi) (spi & (IPSEC_SA_MAX_ENTRIES - 1))
 #define INVALID_SPI (0)
 
-#define DISCARD (0x80000000)
-#define BYPASS (0x40000000)
-#define PROTECT_MASK (0x3fffffff)
-#define PROTECT(sa_idx) (SPI2IDX(sa_idx) & PROTECT_MASK) /* SA idx 30 bits */
+#define DISCARD        INVALID_SPI
+#define BYPASS UINT32_MAX
 
 #define IPSEC_XFORM_MAX 2
 
@@ -78,6 +51,13 @@ struct ipsec_xform;
 struct rte_mbuf;
 
 struct ipsec_sa;
+/*
+ * Keeps number of configured SA's for each address family:
+ */
+struct ipsec_sa_cnt {
+       uint32_t        nb_v4;
+       uint32_t        nb_v6;
+};
 
 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa,
                struct rte_crypto_op *cop);
@@ -92,14 +72,53 @@ struct ip_addr {
        } ip;
 };
 
-#define MAX_KEY_SIZE           32
+#define MAX_KEY_SIZE           36
+
+/*
+ * application wide SA parameters
+ */
+struct app_sa_prm {
+       uint32_t enable; /* use librte_ipsec API for ipsec pkt processing */
+       uint32_t window_size; /* replay window size */
+       uint32_t enable_esn;  /* enable/disable ESN support */
+       uint32_t cache_sz;      /* per lcore SA cache size */
+       uint64_t flags;       /* rte_ipsec_sa_prm.flags */
+};
+
+extern struct app_sa_prm app_sa_prm;
+
+struct flow_info {
+       struct rte_flow *rx_def_flow;
+};
+
+extern struct flow_info flow_info_tbl[RTE_MAX_ETHPORTS];
+
+enum {
+       IPSEC_SESSION_PRIMARY = 0,
+       IPSEC_SESSION_FALLBACK = 1,
+       IPSEC_SESSION_MAX
+};
+
+#define IPSEC_SA_OFFLOAD_FALLBACK_FLAG (1)
+
+static inline struct ipsec_sa *
+ipsec_mask_saptr(void *ptr)
+{
+       uintptr_t i = (uintptr_t)ptr;
+       static const uintptr_t mask = IPSEC_SA_OFFLOAD_FALLBACK_FLAG;
+
+       i &= ~mask;
+
+       return (struct ipsec_sa *)i;
+}
 
 struct ipsec_sa {
+       struct rte_ipsec_session sessions[IPSEC_SESSION_MAX];
        uint32_t spi;
        uint32_t cdev_id_qp;
        uint64_t seq;
        uint32_t salt;
-       struct rte_cryptodev_sym_session *crypto_session;
+       uint32_t fallback_sessions;
        enum rte_crypto_cipher_algorithm cipher_algo;
        enum rte_crypto_auth_algorithm auth_algo;
        enum rte_crypto_aead_algorithm aead_algo;
@@ -110,6 +129,8 @@ struct ipsec_sa {
 #define IP4_TUNNEL (1 << 0)
 #define IP6_TUNNEL (1 << 1)
 #define TRANSPORT  (1 << 2)
+#define IP4_TRANSPORT (1 << 3)
+#define IP6_TRANSPORT (1 << 4)
        struct ip_addr src;
        struct ip_addr dst;
        uint8_t cipher_key[MAX_KEY_SIZE];
@@ -117,9 +138,45 @@ struct ipsec_sa {
        uint8_t auth_key[MAX_KEY_SIZE];
        uint16_t auth_key_len;
        uint16_t aad_len;
-       struct rte_crypto_sym_xform *xforms;
+       union {
+               struct rte_crypto_sym_xform *xforms;
+               struct rte_security_ipsec_xform *sec_xform;
+       };
+       enum rte_security_ipsec_sa_direction direction;
+       uint16_t portid;
+
+#define MAX_RTE_FLOW_PATTERN (4)
+#define MAX_RTE_FLOW_ACTIONS (3)
+       struct rte_flow_item pattern[MAX_RTE_FLOW_PATTERN];
+       struct rte_flow_action action[MAX_RTE_FLOW_ACTIONS];
+       struct rte_flow_attr attr;
+       union {
+               struct rte_flow_item_ipv4 ipv4_spec;
+               struct rte_flow_item_ipv6 ipv6_spec;
+       };
+       struct rte_flow_item_esp esp_spec;
+       struct rte_flow *flow;
+       struct rte_security_session_conf sess_conf;
 } __rte_cache_aligned;
 
+struct ipsec_xf {
+       struct rte_crypto_sym_xform a;
+       struct rte_crypto_sym_xform b;
+};
+
+struct ipsec_sad {
+       struct rte_ipsec_sad *sad_v4;
+       struct rte_ipsec_sad *sad_v6;
+};
+
+struct sa_ctx {
+       void *satbl; /* pointer to array of rte_ipsec_sa objects*/
+       struct ipsec_sad sad;
+       struct ipsec_xf *xf;
+       uint32_t nb_sa;
+       struct ipsec_sa sa[];
+};
+
 struct ipsec_mbuf_metadata {
        struct ipsec_sa *sa;
        struct rte_crypto_op cop;
@@ -127,6 +184,27 @@ struct ipsec_mbuf_metadata {
        uint8_t buf[32];
 } __rte_cache_aligned;
 
+#define IS_TRANSPORT(flags) ((flags) & TRANSPORT)
+
+#define IS_TUNNEL(flags) ((flags) & (IP4_TUNNEL | IP6_TUNNEL))
+
+#define IS_IP4(flags) ((flags) & (IP4_TUNNEL | IP4_TRANSPORT))
+
+#define IS_IP6(flags) ((flags) & (IP6_TUNNEL | IP6_TRANSPORT))
+
+#define IS_IP4_TUNNEL(flags) ((flags) & IP4_TUNNEL)
+
+#define IS_IP6_TUNNEL(flags) ((flags) & IP6_TUNNEL)
+
+/*
+ * Macro for getting ipsec_sa flags statuses without version of protocol
+ * used for transport (IP4_TRANSPORT and IP6_TRANSPORT flags).
+ */
+#define WITHOUT_TRANSPORT_VERSION(flags) \
+               ((flags) & (IP4_TUNNEL | \
+                       IP6_TUNNEL | \
+                       TRANSPORT))
+
 struct cdev_qp {
        uint16_t id;
        uint16_t qp;
@@ -143,12 +221,19 @@ struct ipsec_ctx {
        uint16_t nb_qps;
        uint16_t last_qp;
        struct cdev_qp tbl[MAX_QP_PER_LCORE];
+       struct rte_mempool *session_pool;
+       struct rte_mempool *session_priv_pool;
+       struct rte_mbuf *ol_pkts[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
+       uint16_t ol_pkts_cnt;
+       uint64_t ipv4_offloads;
+       uint64_t ipv6_offloads;
 };
 
 struct cdev_key {
        uint16_t lcore_id;
        uint8_t cipher_algo;
        uint8_t auth_algo;
+       uint8_t aead_algo;
 };
 
 struct socket_ctx {
@@ -161,13 +246,31 @@ struct socket_ctx {
        struct rt_ctx *rt_ip4;
        struct rt_ctx *rt_ip6;
        struct rte_mempool *mbuf_pool;
+       struct rte_mempool *mbuf_pool_indir;
+       struct rte_mempool *session_pool;
+       struct rte_mempool *session_priv_pool;
 };
 
 struct cnt_blk {
        uint32_t salt;
        uint64_t iv;
        uint32_t cnt;
-} __attribute__((packed));
+} __rte_packed;
+
+/* Socket ctx */
+extern struct socket_ctx socket_ctx[NB_SOCKETS];
+
+void
+ipsec_poll_mode_worker(void);
+
+int
+ipsec_launch_one_lcore(void *args);
+
+extern struct ipsec_sa *sa_out;
+extern uint32_t nb_sa_out;
+
+extern struct ipsec_sa *sa_in;
+extern uint32_t nb_sa_in;
 
 uint16_t
 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
@@ -177,6 +280,20 @@ uint16_t
 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
                uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len);
 
+uint16_t
+ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
+               uint16_t len);
+
+uint16_t
+ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
+               uint16_t len);
+
+void
+ipsec_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
+
+void
+ipsec_cqp_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
+
 static inline uint16_t
 ipsec_metadata_size(void)
 {
@@ -186,7 +303,7 @@ ipsec_metadata_size(void)
 static inline struct ipsec_mbuf_metadata *
 get_priv(struct rte_mbuf *m)
 {
-       return RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
+       return rte_mbuf_to_priv(m);
 }
 
 static inline void *
@@ -211,16 +328,36 @@ get_sym_cop(struct rte_crypto_op *cop)
        return (cop + 1);
 }
 
+static inline struct rte_ipsec_session *
+ipsec_get_primary_session(struct ipsec_sa *sa)
+{
+       return &sa->sessions[IPSEC_SESSION_PRIMARY];
+}
+
+static inline struct rte_ipsec_session *
+ipsec_get_fallback_session(struct ipsec_sa *sa)
+{
+       return &sa->sessions[IPSEC_SESSION_FALLBACK];
+}
+
+static inline enum rte_security_session_action_type
+ipsec_get_action_type(struct ipsec_sa *sa)
+{
+       struct rte_ipsec_session *ips;
+       ips = ipsec_get_primary_session(sa);
+       return ips->type;
+}
+
 int
 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx);
 
 void
 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
-               struct ipsec_sa *sa[], uint16_t nb_pkts);
+               void *sa[], uint16_t nb_pkts);
 
 void
 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
-               struct ipsec_sa *sa[], uint16_t nb_pkts);
+               void *sa[], uint16_t nb_pkts);
 
 void
 sp4_init(struct socket_ctx *ctx, int32_t socket_id);
@@ -228,10 +365,48 @@ sp4_init(struct socket_ctx *ctx, int32_t socket_id);
 void
 sp6_init(struct socket_ctx *ctx, int32_t socket_id);
 
+/*
+ * Search through SP rules for given SPI.
+ * Returns first rule index if found(greater or equal then zero),
+ * or -ENOENT otherwise.
+ */
+int
+sp4_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
+                       uint32_t mask[2]);
+int
+sp6_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
+                       uint32_t mask[2]);
+
+/*
+ * Search through SA entries for given SPI.
+ * Returns first entry index if found(greater or equal then zero),
+ * or -ENOENT otherwise.
+ */
+int
+sa_spi_present(struct sa_ctx *sa_ctx, uint32_t spi, int inbound);
+
 void
 sa_init(struct socket_ctx *ctx, int32_t socket_id);
 
 void
 rt_init(struct socket_ctx *ctx, int32_t socket_id);
 
+int
+sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads,
+               uint64_t *tx_offloads);
+
+int
+add_dst_ethaddr(uint16_t port, const struct rte_ether_addr *addr);
+
+void
+enqueue_cop_burst(struct cdev_qp *cqp);
+
+int
+create_lookaside_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa,
+               struct rte_ipsec_session *ips);
+
+int
+create_inline_session(struct socket_ctx *skt_ctx, struct ipsec_sa *sa,
+               struct rte_ipsec_session *ips);
+
 #endif /* __IPSEC_H__ */