examples/ipsec-secgw: add driver mode worker
[dpdk.git] / examples / ipsec-secgw / ipsec.h
index 589398f..ad913bf 100644 (file)
@@ -13,6 +13,8 @@
 #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
@@ -37,8 +39,6 @@
 
 #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        INVALID_SPI
@@ -53,6 +53,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);
@@ -76,21 +83,44 @@ 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 ips; /* one session per sa for now */
+       struct rte_ipsec_session sessions[IPSEC_SESSION_MAX];
        uint32_t spi;
        uint32_t cdev_id_qp;
        uint64_t seq;
        uint32_t salt;
-       union {
-               struct rte_cryptodev_sym_session *crypto_session;
-               struct rte_security_session *sec_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;
@@ -101,6 +131,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];
@@ -112,11 +144,8 @@ struct ipsec_sa {
                struct rte_crypto_sym_xform *xforms;
                struct rte_security_ipsec_xform *sec_xform;
        };
-       enum rte_security_session_action_type type;
        enum rte_security_ipsec_sa_direction direction;
        uint16_t portid;
-       struct rte_security_ctx *security_ctx;
-       uint32_t ol_flags;
 
 #define MAX_RTE_FLOW_PATTERN (4)
 #define MAX_RTE_FLOW_ACTIONS (3)
@@ -132,6 +161,24 @@ struct ipsec_sa {
        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;
@@ -139,6 +186,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;
@@ -180,6 +248,7 @@ 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;
 };
@@ -193,7 +262,7 @@ struct cnt_blk {
 struct traffic_type {
        const uint8_t *data[MAX_PKT_BURST * 2];
        struct rte_mbuf *pkts[MAX_PKT_BURST * 2];
-       struct ipsec_sa *saptr[MAX_PKT_BURST * 2];
+       void *saptr[MAX_PKT_BURST * 2];
        uint32_t res[MAX_PKT_BURST * 2];
        uint32_t num;
 };
@@ -204,6 +273,21 @@ struct ipsec_traffic {
        struct traffic_type ip6;
 };
 
+/* 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[],
                uint16_t nb_pkts, uint16_t len);
@@ -260,16 +344,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);
@@ -283,9 +387,11 @@ sp6_init(struct socket_ctx *ctx, int32_t socket_id);
  * or -ENOENT otherwise.
  */
 int
-sp4_spi_present(uint32_t spi, int inbound);
+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);
+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.
@@ -293,7 +399,7 @@ sp6_spi_present(uint32_t spi, int inbound);
  * or -ENOENT otherwise.
  */
 int
-sa_spi_present(uint32_t spi, int inbound);
+sa_spi_present(struct sa_ctx *sa_ctx, uint32_t spi, int inbound);
 
 void
 sa_init(struct socket_ctx *ctx, int32_t socket_id);
@@ -306,12 +412,17 @@ sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads,
                uint64_t *tx_offloads);
 
 int
-add_dst_ethaddr(uint16_t port, const struct ether_addr *addr);
+add_dst_ethaddr(uint16_t port, const struct rte_ether_addr *addr);
 
 void
 enqueue_cop_burst(struct cdev_qp *cqp);
 
 int
-create_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa);
+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__ */