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 #define RTE_LOGTYPE_IPSEC RTE_LOGTYPE_USER1
17 #define RTE_LOGTYPE_IPSEC_ESP RTE_LOGTYPE_USER2
18 #define RTE_LOGTYPE_IPSEC_IPIP RTE_LOGTYPE_USER3
20 #define MAX_PKT_BURST 32
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 uint32_t_to_char(ip, a, b, c, d) do {\
32 *a = (uint8_t)(ip >> 24 & 0xff);\
33 *b = (uint8_t)(ip >> 16 & 0xff);\
34 *c = (uint8_t)(ip >> 8 & 0xff);\
35 *d = (uint8_t)(ip & 0xff);\
38 #define DEFAULT_MAX_CATEGORIES 1
40 #define IPSEC_SA_MAX_ENTRIES (128) /* must be power of 2, max 2 power 30 */
41 #define SPI2IDX(spi) (spi & (IPSEC_SA_MAX_ENTRIES - 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 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa,
58 struct rte_crypto_op *cop);
70 #define MAX_KEY_SIZE 32
73 * application wide SA parameters
76 uint32_t enable; /* use librte_ipsec API for ipsec pkt processing */
77 uint32_t window_size; /* replay window size */
78 uint32_t enable_esn; /* enable/disable ESN support */
79 uint64_t flags; /* rte_ipsec_sa_prm.flags */
82 extern struct app_sa_prm app_sa_prm;
85 IPSEC_SESSION_PRIMARY = 0,
86 IPSEC_SESSION_FALLBACK = 1,
90 #define IPSEC_SA_OFFLOAD_FALLBACK_FLAG (1)
92 static inline struct ipsec_sa *
93 ipsec_mask_saptr(void *ptr)
95 uintptr_t i = (uintptr_t)ptr;
96 static const uintptr_t mask = IPSEC_SA_OFFLOAD_FALLBACK_FLAG;
100 return (struct ipsec_sa *)i;
104 struct rte_ipsec_session sessions[IPSEC_SESSION_MAX];
109 uint32_t fallback_sessions;
110 enum rte_crypto_cipher_algorithm cipher_algo;
111 enum rte_crypto_auth_algorithm auth_algo;
112 enum rte_crypto_aead_algorithm aead_algo;
117 #define IP4_TUNNEL (1 << 0)
118 #define IP6_TUNNEL (1 << 1)
119 #define TRANSPORT (1 << 2)
120 #define IP4_TRANSPORT (1 << 3)
121 #define IP6_TRANSPORT (1 << 4)
124 uint8_t cipher_key[MAX_KEY_SIZE];
125 uint16_t cipher_key_len;
126 uint8_t auth_key[MAX_KEY_SIZE];
127 uint16_t auth_key_len;
130 struct rte_crypto_sym_xform *xforms;
131 struct rte_security_ipsec_xform *sec_xform;
133 enum rte_security_ipsec_sa_direction direction;
136 #define MAX_RTE_FLOW_PATTERN (4)
137 #define MAX_RTE_FLOW_ACTIONS (3)
138 struct rte_flow_item pattern[MAX_RTE_FLOW_PATTERN];
139 struct rte_flow_action action[MAX_RTE_FLOW_ACTIONS];
140 struct rte_flow_attr attr;
142 struct rte_flow_item_ipv4 ipv4_spec;
143 struct rte_flow_item_ipv6 ipv6_spec;
145 struct rte_flow_item_esp esp_spec;
146 struct rte_flow *flow;
147 struct rte_security_session_conf sess_conf;
148 } __rte_cache_aligned;
150 struct ipsec_mbuf_metadata {
152 struct rte_crypto_op cop;
153 struct rte_crypto_sym_op sym_cop;
155 } __rte_cache_aligned;
157 #define IS_TRANSPORT(flags) ((flags) & TRANSPORT)
159 #define IS_TUNNEL(flags) ((flags) & (IP4_TUNNEL | IP6_TUNNEL))
161 #define IS_IP4(flags) ((flags) & (IP4_TUNNEL | IP4_TRANSPORT))
163 #define IS_IP6(flags) ((flags) & (IP6_TUNNEL | IP6_TRANSPORT))
165 #define IS_IP4_TUNNEL(flags) ((flags) & IP4_TUNNEL)
167 #define IS_IP6_TUNNEL(flags) ((flags) & IP6_TUNNEL)
170 * Macro for getting ipsec_sa flags statuses without version of protocol
171 * used for transport (IP4_TRANSPORT and IP6_TRANSPORT flags).
173 #define WITHOUT_TRANSPORT_VERSION(flags) \
174 ((flags) & (IP4_TUNNEL | \
183 struct rte_crypto_op *buf[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
187 struct rte_hash *cdev_map;
188 struct sp_ctx *sp4_ctx;
189 struct sp_ctx *sp6_ctx;
190 struct sa_ctx *sa_ctx;
193 struct cdev_qp tbl[MAX_QP_PER_LCORE];
194 struct rte_mempool *session_pool;
195 struct rte_mempool *session_priv_pool;
196 struct rte_mbuf *ol_pkts[MAX_PKT_BURST] __rte_aligned(sizeof(void *));
197 uint16_t ol_pkts_cnt;
198 uint64_t ipv4_offloads;
199 uint64_t ipv6_offloads;
210 struct sa_ctx *sa_in;
211 struct sa_ctx *sa_out;
212 struct sp_ctx *sp_ip4_in;
213 struct sp_ctx *sp_ip4_out;
214 struct sp_ctx *sp_ip6_in;
215 struct sp_ctx *sp_ip6_out;
216 struct rt_ctx *rt_ip4;
217 struct rt_ctx *rt_ip6;
218 struct rte_mempool *mbuf_pool;
219 struct rte_mempool *mbuf_pool_indir;
220 struct rte_mempool *session_pool;
221 struct rte_mempool *session_priv_pool;
228 } __attribute__((packed));
230 struct traffic_type {
231 const uint8_t *data[MAX_PKT_BURST * 2];
232 struct rte_mbuf *pkts[MAX_PKT_BURST * 2];
233 void *saptr[MAX_PKT_BURST * 2];
234 uint32_t res[MAX_PKT_BURST * 2];
238 struct ipsec_traffic {
239 struct traffic_type ipsec;
240 struct traffic_type ip4;
241 struct traffic_type ip6;
245 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
246 uint16_t nb_pkts, uint16_t len);
249 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
250 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len);
253 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
257 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
261 ipsec_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
264 ipsec_cqp_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf);
266 static inline uint16_t
267 ipsec_metadata_size(void)
269 return sizeof(struct ipsec_mbuf_metadata);
272 static inline struct ipsec_mbuf_metadata *
273 get_priv(struct rte_mbuf *m)
275 return rte_mbuf_to_priv(m);
279 get_cnt_blk(struct rte_mbuf *m)
281 struct ipsec_mbuf_metadata *priv = get_priv(m);
283 return &priv->buf[0];
287 get_aad(struct rte_mbuf *m)
289 struct ipsec_mbuf_metadata *priv = get_priv(m);
291 return &priv->buf[16];
295 get_sym_cop(struct rte_crypto_op *cop)
300 static inline struct rte_ipsec_session *
301 ipsec_get_primary_session(struct ipsec_sa *sa)
303 return &sa->sessions[IPSEC_SESSION_PRIMARY];
306 static inline struct rte_ipsec_session *
307 ipsec_get_fallback_session(struct ipsec_sa *sa)
309 return &sa->sessions[IPSEC_SESSION_FALLBACK];
312 static inline enum rte_security_session_action_type
313 ipsec_get_action_type(struct ipsec_sa *sa)
315 struct rte_ipsec_session *ips;
316 ips = ipsec_get_primary_session(sa);
321 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx);
324 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
325 void *sa[], uint16_t nb_pkts);
328 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
329 void *sa[], uint16_t nb_pkts);
332 sp4_init(struct socket_ctx *ctx, int32_t socket_id);
335 sp6_init(struct socket_ctx *ctx, int32_t socket_id);
338 * Search through SP rules for given SPI.
339 * Returns first rule index if found(greater or equal then zero),
340 * or -ENOENT otherwise.
343 sp4_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
346 sp6_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2],
350 * Search through SA entries for given SPI.
351 * Returns first entry index if found(greater or equal then zero),
352 * or -ENOENT otherwise.
355 sa_spi_present(uint32_t spi, int inbound);
358 sa_init(struct socket_ctx *ctx, int32_t socket_id);
361 rt_init(struct socket_ctx *ctx, int32_t socket_id);
364 sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads,
365 uint64_t *tx_offloads);
368 add_dst_ethaddr(uint16_t port, const struct rte_ether_addr *addr);
371 enqueue_cop_burst(struct cdev_qp *cqp);
374 create_lookaside_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa,
375 struct rte_ipsec_session *ips);
378 create_inline_session(struct socket_ctx *skt_ctx, struct ipsec_sa *sa,
379 struct rte_ipsec_session *ips);
381 #endif /* __IPSEC_H__ */