1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2017 Intel Corporation
10 #include <rte_byteorder.h>
11 #include <rte_crypto.h>
12 #include <rte_security.h>
14 #include <rte_ipsec.h>
16 #include "ipsec-secgw.h"
18 #define RTE_LOGTYPE_IPSEC_ESP RTE_LOGTYPE_USER2
19 #define RTE_LOGTYPE_IPSEC_IPIP RTE_LOGTYPE_USER3
21 #define MAX_INFLIGHT 128
22 #define MAX_QP_PER_LCORE 256
24 #define MAX_DIGEST_SIZE 32 /* Bytes -- 256 bits */
26 #define IPSEC_OFFLOAD_ESN_SOFTLIMIT 0xffffff00
28 #define IV_OFFSET (sizeof(struct rte_crypto_op) + \
29 sizeof(struct rte_crypto_sym_op))
31 #define DEFAULT_MAX_CATEGORIES 1
33 #define INVALID_SPI (0)
35 #define DISCARD INVALID_SPI
36 #define BYPASS UINT32_MAX
38 #define IPSEC_XFORM_MAX 2
40 #define IP6_VERSION (6)
42 struct rte_crypto_xform;
48 * Keeps number of configured SA's for each address family:
55 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa,
56 struct rte_crypto_op *cop);
68 #define MAX_KEY_SIZE 36
71 * application wide SA parameters
74 uint32_t enable; /* use librte_ipsec API for ipsec pkt processing */
75 uint32_t window_size; /* replay window size */
76 uint32_t enable_esn; /* enable/disable ESN support */
77 uint32_t cache_sz; /* per lcore SA cache size */
78 uint64_t flags; /* rte_ipsec_sa_prm.flags */
81 extern struct app_sa_prm app_sa_prm;
84 struct rte_flow *rx_def_flow;
87 extern struct flow_info flow_info_tbl[RTE_MAX_ETHPORTS];
90 IPSEC_SESSION_PRIMARY = 0,
91 IPSEC_SESSION_FALLBACK = 1,
95 #define IPSEC_SA_OFFLOAD_FALLBACK_FLAG (1)
97 static inline struct ipsec_sa *
98 ipsec_mask_saptr(void *ptr)
100 uintptr_t i = (uintptr_t)ptr;
101 static const uintptr_t mask = IPSEC_SA_OFFLOAD_FALLBACK_FLAG;
105 return (struct ipsec_sa *)i;
109 struct rte_ipsec_session sessions[IPSEC_SESSION_MAX];
114 uint32_t fallback_sessions;
115 enum rte_crypto_cipher_algorithm cipher_algo;
116 enum rte_crypto_auth_algorithm auth_algo;
117 enum rte_crypto_aead_algorithm aead_algo;
122 #define IP4_TUNNEL (1 << 0)
123 #define IP6_TUNNEL (1 << 1)
124 #define TRANSPORT (1 << 2)
125 #define IP4_TRANSPORT (1 << 3)
126 #define IP6_TRANSPORT (1 << 4)
129 uint8_t cipher_key[MAX_KEY_SIZE];
130 uint16_t cipher_key_len;
131 uint8_t auth_key[MAX_KEY_SIZE];
132 uint16_t auth_key_len;
135 struct rte_crypto_sym_xform *xforms;
136 struct rte_security_ipsec_xform *sec_xform;
138 enum rte_security_ipsec_sa_direction direction;
143 #define MAX_RTE_FLOW_PATTERN (4)
144 #define MAX_RTE_FLOW_ACTIONS (3)
145 struct rte_flow_item pattern[MAX_RTE_FLOW_PATTERN];
146 struct rte_flow_action action[MAX_RTE_FLOW_ACTIONS];
147 struct rte_flow_attr attr;
149 struct rte_flow_item_ipv4 ipv4_spec;
150 struct rte_flow_item_ipv6 ipv6_spec;
152 struct rte_flow_item_esp esp_spec;
153 struct rte_flow *flow;
154 struct rte_security_session_conf sess_conf;
155 } __rte_cache_aligned;
158 struct rte_crypto_sym_xform a;
159 struct rte_crypto_sym_xform b;
163 struct rte_ipsec_sad *sad_v4;
164 struct rte_ipsec_sad *sad_v6;
168 void *satbl; /* pointer to array of rte_ipsec_sa objects*/
169 struct ipsec_sad sad;
172 struct ipsec_sa sa[];
175 struct ipsec_mbuf_metadata {
177 struct rte_crypto_op cop;
178 struct rte_crypto_sym_op sym_cop;
180 } __rte_cache_aligned;
182 #define IS_TRANSPORT(flags) ((flags) & TRANSPORT)
184 #define IS_TUNNEL(flags) ((flags) & (IP4_TUNNEL | IP6_TUNNEL))
186 #define IS_IP4(flags) ((flags) & (IP4_TUNNEL | IP4_TRANSPORT))
188 #define IS_IP6(flags) ((flags) & (IP6_TUNNEL | IP6_TRANSPORT))
190 #define IS_IP4_TUNNEL(flags) ((flags) & IP4_TUNNEL)
192 #define IS_IP6_TUNNEL(flags) ((flags) & IP6_TUNNEL)
195 * Macro for getting ipsec_sa flags statuses without version of protocol
196 * used for transport (IP4_TRANSPORT and IP6_TRANSPORT flags).
198 #define WITHOUT_TRANSPORT_VERSION(flags) \
199 ((flags) & (IP4_TUNNEL | \
208 struct rte_crypto_op *buf[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
212 struct rte_hash *cdev_map;
213 struct sp_ctx *sp4_ctx;
214 struct sp_ctx *sp6_ctx;
215 struct sa_ctx *sa_ctx;
218 struct cdev_qp tbl[MAX_QP_PER_LCORE];
219 struct rte_mempool *session_pool;
220 struct rte_mempool *session_priv_pool;
221 struct rte_mbuf *ol_pkts[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
222 uint16_t ol_pkts_cnt;
223 uint64_t ipv4_offloads;
224 uint64_t ipv6_offloads;
235 struct sa_ctx *sa_in;
236 struct sa_ctx *sa_out;
237 struct sp_ctx *sp_ip4_in;
238 struct sp_ctx *sp_ip4_out;
239 struct sp_ctx *sp_ip6_in;
240 struct sp_ctx *sp_ip6_out;
241 struct rt_ctx *rt_ip4;
242 struct rt_ctx *rt_ip6;
243 struct rte_mempool *mbuf_pool;
244 struct rte_mempool *mbuf_pool_indir;
245 struct rte_mempool *session_pool;
246 struct rte_mempool *session_priv_pool;
256 extern struct socket_ctx socket_ctx[NB_SOCKETS];
259 ipsec_poll_mode_worker(void);
262 ipsec_launch_one_lcore(void *args);
264 extern struct ipsec_sa *sa_out;
265 extern uint32_t nb_sa_out;
267 extern struct ipsec_sa *sa_in;
268 extern uint32_t nb_sa_in;
271 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
272 uint16_t nb_pkts, uint16_t len);
275 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
276 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len);
279 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
283 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
287 ipsec_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
290 ipsec_cqp_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
292 static inline uint16_t
293 ipsec_metadata_size(void)
295 return sizeof(struct ipsec_mbuf_metadata);
298 static inline struct ipsec_mbuf_metadata *
299 get_priv(struct rte_mbuf *m)
301 return rte_mbuf_to_priv(m);
305 get_cnt_blk(struct rte_mbuf *m)
307 struct ipsec_mbuf_metadata *priv = get_priv(m);
309 return &priv->buf[0];
313 get_aad(struct rte_mbuf *m)
315 struct ipsec_mbuf_metadata *priv = get_priv(m);
317 return &priv->buf[16];
321 get_sym_cop(struct rte_crypto_op *cop)
326 static inline struct rte_ipsec_session *
327 ipsec_get_primary_session(struct ipsec_sa *sa)
329 return &sa->sessions[IPSEC_SESSION_PRIMARY];
332 static inline struct rte_ipsec_session *
333 ipsec_get_fallback_session(struct ipsec_sa *sa)
335 return &sa->sessions[IPSEC_SESSION_FALLBACK];
338 static inline enum rte_security_session_action_type
339 ipsec_get_action_type(struct ipsec_sa *sa)
341 struct rte_ipsec_session *ips;
342 ips = ipsec_get_primary_session(sa);
347 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx);
350 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
351 void *sa[], uint16_t nb_pkts);
354 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
355 void *sa[], uint16_t nb_pkts);
358 sp4_init(struct socket_ctx *ctx, int32_t socket_id);
361 sp6_init(struct socket_ctx *ctx, int32_t socket_id);
364 * Search through SP rules for given SPI.
365 * Returns first rule index if found(greater or equal then zero),
366 * or -ENOENT otherwise.
369 sp4_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
372 sp6_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
376 * Search through SA entries for given SPI.
377 * Returns first entry index if found(greater or equal then zero),
378 * or -ENOENT otherwise.
381 sa_spi_present(struct sa_ctx *sa_ctx, uint32_t spi, int inbound);
384 sa_init(struct socket_ctx *ctx, int32_t socket_id);
387 rt_init(struct socket_ctx *ctx, int32_t socket_id);
390 sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads,
391 uint64_t *tx_offloads);
394 add_dst_ethaddr(uint16_t port, const struct rte_ether_addr *addr);
397 enqueue_cop_burst(struct cdev_qp *cqp);
400 create_lookaside_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa,
401 struct rte_ipsec_session *ips);
404 create_inline_session(struct socket_ctx *skt_ctx, struct ipsec_sa *sa,
405 struct rte_ipsec_session *ips);
407 check_flow_params(uint16_t fdir_portid, uint8_t fdir_qid);
410 create_ipsec_esp_flow(struct ipsec_sa *sa);
413 get_nb_crypto_sessions(void);
415 #endif /* __IPSEC_H__ */