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 RTE_LOGTYPE_USER1
19 #define RTE_LOGTYPE_IPSEC_ESP RTE_LOGTYPE_USER2
20 #define RTE_LOGTYPE_IPSEC_IPIP RTE_LOGTYPE_USER3
22 #define MAX_PKT_BURST 32
23 #define MAX_INFLIGHT 128
24 #define MAX_QP_PER_LCORE 256
26 #define MAX_DIGEST_SIZE 32 /* Bytes -- 256 bits */
28 #define IPSEC_OFFLOAD_ESN_SOFTLIMIT 0xffffff00
30 #define IV_OFFSET (sizeof(struct rte_crypto_op) + \
31 sizeof(struct rte_crypto_sym_op))
33 #define uint32_t_to_char(ip, a, b, c, d) do {\
34 *a = (uint8_t)(ip >> 24 & 0xff);\
35 *b = (uint8_t)(ip >> 16 & 0xff);\
36 *c = (uint8_t)(ip >> 8 & 0xff);\
37 *d = (uint8_t)(ip & 0xff);\
40 #define DEFAULT_MAX_CATEGORIES 1
42 #define INVALID_SPI (0)
44 #define DISCARD INVALID_SPI
45 #define BYPASS UINT32_MAX
47 #define IPSEC_XFORM_MAX 2
49 #define IP6_VERSION (6)
51 struct rte_crypto_xform;
57 * Keeps number of configured SA's for each address family:
64 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa,
65 struct rte_crypto_op *cop);
77 #define MAX_KEY_SIZE 32
80 * application wide SA parameters
83 uint32_t enable; /* use librte_ipsec API for ipsec pkt processing */
84 uint32_t window_size; /* replay window size */
85 uint32_t enable_esn; /* enable/disable ESN support */
86 uint32_t cache_sz; /* per lcore SA cache size */
87 uint64_t flags; /* rte_ipsec_sa_prm.flags */
90 extern struct app_sa_prm app_sa_prm;
93 struct rte_flow *rx_def_flow;
96 extern struct flow_info flow_info_tbl[RTE_MAX_ETHPORTS];
99 IPSEC_SESSION_PRIMARY = 0,
100 IPSEC_SESSION_FALLBACK = 1,
104 #define IPSEC_SA_OFFLOAD_FALLBACK_FLAG (1)
106 static inline struct ipsec_sa *
107 ipsec_mask_saptr(void *ptr)
109 uintptr_t i = (uintptr_t)ptr;
110 static const uintptr_t mask = IPSEC_SA_OFFLOAD_FALLBACK_FLAG;
114 return (struct ipsec_sa *)i;
118 struct rte_ipsec_session sessions[IPSEC_SESSION_MAX];
123 uint32_t fallback_sessions;
124 enum rte_crypto_cipher_algorithm cipher_algo;
125 enum rte_crypto_auth_algorithm auth_algo;
126 enum rte_crypto_aead_algorithm aead_algo;
131 #define IP4_TUNNEL (1 << 0)
132 #define IP6_TUNNEL (1 << 1)
133 #define TRANSPORT (1 << 2)
134 #define IP4_TRANSPORT (1 << 3)
135 #define IP6_TRANSPORT (1 << 4)
138 uint8_t cipher_key[MAX_KEY_SIZE];
139 uint16_t cipher_key_len;
140 uint8_t auth_key[MAX_KEY_SIZE];
141 uint16_t auth_key_len;
144 struct rte_crypto_sym_xform *xforms;
145 struct rte_security_ipsec_xform *sec_xform;
147 enum rte_security_ipsec_sa_direction direction;
150 #define MAX_RTE_FLOW_PATTERN (4)
151 #define MAX_RTE_FLOW_ACTIONS (3)
152 struct rte_flow_item pattern[MAX_RTE_FLOW_PATTERN];
153 struct rte_flow_action action[MAX_RTE_FLOW_ACTIONS];
154 struct rte_flow_attr attr;
156 struct rte_flow_item_ipv4 ipv4_spec;
157 struct rte_flow_item_ipv6 ipv6_spec;
159 struct rte_flow_item_esp esp_spec;
160 struct rte_flow *flow;
161 struct rte_security_session_conf sess_conf;
162 } __rte_cache_aligned;
165 struct rte_crypto_sym_xform a;
166 struct rte_crypto_sym_xform b;
170 struct rte_ipsec_sad *sad_v4;
171 struct rte_ipsec_sad *sad_v6;
175 void *satbl; /* pointer to array of rte_ipsec_sa objects*/
176 struct ipsec_sad sad;
179 struct ipsec_sa sa[];
182 struct ipsec_mbuf_metadata {
184 struct rte_crypto_op cop;
185 struct rte_crypto_sym_op sym_cop;
187 } __rte_cache_aligned;
189 #define IS_TRANSPORT(flags) ((flags) & TRANSPORT)
191 #define IS_TUNNEL(flags) ((flags) & (IP4_TUNNEL | IP6_TUNNEL))
193 #define IS_IP4(flags) ((flags) & (IP4_TUNNEL | IP4_TRANSPORT))
195 #define IS_IP6(flags) ((flags) & (IP6_TUNNEL | IP6_TRANSPORT))
197 #define IS_IP4_TUNNEL(flags) ((flags) & IP4_TUNNEL)
199 #define IS_IP6_TUNNEL(flags) ((flags) & IP6_TUNNEL)
202 * Macro for getting ipsec_sa flags statuses without version of protocol
203 * used for transport (IP4_TRANSPORT and IP6_TRANSPORT flags).
205 #define WITHOUT_TRANSPORT_VERSION(flags) \
206 ((flags) & (IP4_TUNNEL | \
215 struct rte_crypto_op *buf[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
219 struct rte_hash *cdev_map;
220 struct sp_ctx *sp4_ctx;
221 struct sp_ctx *sp6_ctx;
222 struct sa_ctx *sa_ctx;
225 struct cdev_qp tbl[MAX_QP_PER_LCORE];
226 struct rte_mempool *session_pool;
227 struct rte_mempool *session_priv_pool;
228 struct rte_mbuf *ol_pkts[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
229 uint16_t ol_pkts_cnt;
230 uint64_t ipv4_offloads;
231 uint64_t ipv6_offloads;
242 struct sa_ctx *sa_in;
243 struct sa_ctx *sa_out;
244 struct sp_ctx *sp_ip4_in;
245 struct sp_ctx *sp_ip4_out;
246 struct sp_ctx *sp_ip6_in;
247 struct sp_ctx *sp_ip6_out;
248 struct rt_ctx *rt_ip4;
249 struct rt_ctx *rt_ip6;
250 struct rte_mempool *mbuf_pool;
251 struct rte_mempool *mbuf_pool_indir;
252 struct rte_mempool *session_pool;
253 struct rte_mempool *session_priv_pool;
260 } __attribute__((packed));
262 struct traffic_type {
263 const uint8_t *data[MAX_PKT_BURST * 2];
264 struct rte_mbuf *pkts[MAX_PKT_BURST * 2];
265 void *saptr[MAX_PKT_BURST * 2];
266 uint32_t res[MAX_PKT_BURST * 2];
270 struct ipsec_traffic {
271 struct traffic_type ipsec;
272 struct traffic_type ip4;
273 struct traffic_type ip6;
277 extern struct socket_ctx socket_ctx[NB_SOCKETS];
280 ipsec_poll_mode_worker(void);
283 ipsec_launch_one_lcore(void *args);
285 extern struct ipsec_sa *sa_out;
286 extern uint32_t nb_sa_out;
288 extern struct ipsec_sa *sa_in;
289 extern uint32_t nb_sa_in;
292 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
293 uint16_t nb_pkts, uint16_t len);
296 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
297 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len);
300 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
304 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
308 ipsec_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
311 ipsec_cqp_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
313 static inline uint16_t
314 ipsec_metadata_size(void)
316 return sizeof(struct ipsec_mbuf_metadata);
319 static inline struct ipsec_mbuf_metadata *
320 get_priv(struct rte_mbuf *m)
322 return rte_mbuf_to_priv(m);
326 get_cnt_blk(struct rte_mbuf *m)
328 struct ipsec_mbuf_metadata *priv = get_priv(m);
330 return &priv->buf[0];
334 get_aad(struct rte_mbuf *m)
336 struct ipsec_mbuf_metadata *priv = get_priv(m);
338 return &priv->buf[16];
342 get_sym_cop(struct rte_crypto_op *cop)
347 static inline struct rte_ipsec_session *
348 ipsec_get_primary_session(struct ipsec_sa *sa)
350 return &sa->sessions[IPSEC_SESSION_PRIMARY];
353 static inline struct rte_ipsec_session *
354 ipsec_get_fallback_session(struct ipsec_sa *sa)
356 return &sa->sessions[IPSEC_SESSION_FALLBACK];
359 static inline enum rte_security_session_action_type
360 ipsec_get_action_type(struct ipsec_sa *sa)
362 struct rte_ipsec_session *ips;
363 ips = ipsec_get_primary_session(sa);
368 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx);
371 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
372 void *sa[], uint16_t nb_pkts);
375 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
376 void *sa[], uint16_t nb_pkts);
379 sp4_init(struct socket_ctx *ctx, int32_t socket_id);
382 sp6_init(struct socket_ctx *ctx, int32_t socket_id);
385 * Search through SP rules for given SPI.
386 * Returns first rule index if found(greater or equal then zero),
387 * or -ENOENT otherwise.
390 sp4_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
393 sp6_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
397 * Search through SA entries for given SPI.
398 * Returns first entry index if found(greater or equal then zero),
399 * or -ENOENT otherwise.
402 sa_spi_present(struct sa_ctx *sa_ctx, uint32_t spi, int inbound);
405 sa_init(struct socket_ctx *ctx, int32_t socket_id);
408 rt_init(struct socket_ctx *ctx, int32_t socket_id);
411 sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads,
412 uint64_t *tx_offloads);
415 add_dst_ethaddr(uint16_t port, const struct rte_ether_addr *addr);
418 enqueue_cop_burst(struct cdev_qp *cqp);
421 create_lookaside_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa,
422 struct rte_ipsec_session *ips);
425 create_inline_session(struct socket_ctx *skt_ctx, struct ipsec_sa *sa,
426 struct rte_ipsec_session *ips);
428 #endif /* __IPSEC_H__ */