1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2016-2017 Intel Corporation 3 */ 4 5 #ifndef __IPSEC_H__ 6 #define __IPSEC_H__ 7 8 #include <stdint.h> 9 10 #include <rte_byteorder.h> 11 #include <rte_crypto.h> 12 #include <rte_security.h> 13 #include <rte_flow.h> 14 #include <rte_ipsec.h> 15 16 #include "ipsec-secgw.h" 17 18 #define RTE_LOGTYPE_IPSEC_ESP RTE_LOGTYPE_USER2 19 #define RTE_LOGTYPE_IPSEC_IPIP RTE_LOGTYPE_USER3 20 21 #define MAX_INFLIGHT 128 22 #define MAX_QP_PER_LCORE 256 23 24 #define MAX_DIGEST_SIZE 32 /* Bytes -- 256 bits */ 25 26 #define IPSEC_OFFLOAD_ESN_SOFTLIMIT 0xffffff00 27 28 #define IV_OFFSET (sizeof(struct rte_crypto_op) + \ 29 sizeof(struct rte_crypto_sym_op)) 30 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);\ 36 } while (0) 37 38 #define DEFAULT_MAX_CATEGORIES 1 39 40 #define INVALID_SPI (0) 41 42 #define DISCARD INVALID_SPI 43 #define BYPASS UINT32_MAX 44 45 #define IPSEC_XFORM_MAX 2 46 47 #define IP6_VERSION (6) 48 49 struct rte_crypto_xform; 50 struct ipsec_xform; 51 struct rte_mbuf; 52 53 struct ipsec_sa; 54 /* 55 * Keeps number of configured SA's for each address family: 56 */ 57 struct ipsec_sa_cnt { 58 uint32_t nb_v4; 59 uint32_t nb_v6; 60 }; 61 62 typedef int32_t (*ipsec_xform_fn)(struct rte_mbuf *m, struct ipsec_sa *sa, 63 struct rte_crypto_op *cop); 64 65 struct ip_addr { 66 union { 67 uint32_t ip4; 68 union { 69 uint64_t ip6[2]; 70 uint8_t ip6_b[16]; 71 } ip6; 72 } ip; 73 }; 74 75 #define MAX_KEY_SIZE 36 76 77 /* 78 * application wide SA parameters 79 */ 80 struct app_sa_prm { 81 uint32_t enable; /* use librte_ipsec API for ipsec pkt processing */ 82 uint32_t window_size; /* replay window size */ 83 uint32_t enable_esn; /* enable/disable ESN support */ 84 uint32_t cache_sz; /* per lcore SA cache size */ 85 uint64_t flags; /* rte_ipsec_sa_prm.flags */ 86 }; 87 88 extern struct app_sa_prm app_sa_prm; 89 90 struct flow_info { 91 struct rte_flow *rx_def_flow; 92 }; 93 94 extern struct flow_info flow_info_tbl[RTE_MAX_ETHPORTS]; 95 96 enum { 97 IPSEC_SESSION_PRIMARY = 0, 98 IPSEC_SESSION_FALLBACK = 1, 99 IPSEC_SESSION_MAX 100 }; 101 102 #define IPSEC_SA_OFFLOAD_FALLBACK_FLAG (1) 103 104 static inline struct ipsec_sa * 105 ipsec_mask_saptr(void *ptr) 106 { 107 uintptr_t i = (uintptr_t)ptr; 108 static const uintptr_t mask = IPSEC_SA_OFFLOAD_FALLBACK_FLAG; 109 110 i &= ~mask; 111 112 return (struct ipsec_sa *)i; 113 } 114 115 struct ipsec_sa { 116 struct rte_ipsec_session sessions[IPSEC_SESSION_MAX]; 117 uint32_t spi; 118 uint32_t cdev_id_qp; 119 uint64_t seq; 120 uint32_t salt; 121 uint32_t fallback_sessions; 122 enum rte_crypto_cipher_algorithm cipher_algo; 123 enum rte_crypto_auth_algorithm auth_algo; 124 enum rte_crypto_aead_algorithm aead_algo; 125 uint16_t digest_len; 126 uint16_t iv_len; 127 uint16_t block_size; 128 uint16_t flags; 129 #define IP4_TUNNEL (1 << 0) 130 #define IP6_TUNNEL (1 << 1) 131 #define TRANSPORT (1 << 2) 132 #define IP4_TRANSPORT (1 << 3) 133 #define IP6_TRANSPORT (1 << 4) 134 struct ip_addr src; 135 struct ip_addr dst; 136 uint8_t cipher_key[MAX_KEY_SIZE]; 137 uint16_t cipher_key_len; 138 uint8_t auth_key[MAX_KEY_SIZE]; 139 uint16_t auth_key_len; 140 uint16_t aad_len; 141 union { 142 struct rte_crypto_sym_xform *xforms; 143 struct rte_security_ipsec_xform *sec_xform; 144 }; 145 enum rte_security_ipsec_sa_direction direction; 146 uint16_t portid; 147 uint8_t fdir_qid; 148 uint8_t fdir_flag; 149 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; 155 union { 156 struct rte_flow_item_ipv4 ipv4_spec; 157 struct rte_flow_item_ipv6 ipv6_spec; 158 }; 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; 163 164 struct ipsec_xf { 165 struct rte_crypto_sym_xform a; 166 struct rte_crypto_sym_xform b; 167 }; 168 169 struct ipsec_sad { 170 struct rte_ipsec_sad *sad_v4; 171 struct rte_ipsec_sad *sad_v6; 172 }; 173 174 struct sa_ctx { 175 void *satbl; /* pointer to array of rte_ipsec_sa objects*/ 176 struct ipsec_sad sad; 177 struct ipsec_xf *xf; 178 uint32_t nb_sa; 179 struct ipsec_sa sa[]; 180 }; 181 182 struct ipsec_mbuf_metadata { 183 struct ipsec_sa *sa; 184 struct rte_crypto_op cop; 185 struct rte_crypto_sym_op sym_cop; 186 uint8_t buf[32]; 187 } __rte_cache_aligned; 188 189 #define IS_TRANSPORT(flags) ((flags) & TRANSPORT) 190 191 #define IS_TUNNEL(flags) ((flags) & (IP4_TUNNEL | IP6_TUNNEL)) 192 193 #define IS_IP4(flags) ((flags) & (IP4_TUNNEL | IP4_TRANSPORT)) 194 195 #define IS_IP6(flags) ((flags) & (IP6_TUNNEL | IP6_TRANSPORT)) 196 197 #define IS_IP4_TUNNEL(flags) ((flags) & IP4_TUNNEL) 198 199 #define IS_IP6_TUNNEL(flags) ((flags) & IP6_TUNNEL) 200 201 /* 202 * Macro for getting ipsec_sa flags statuses without version of protocol 203 * used for transport (IP4_TRANSPORT and IP6_TRANSPORT flags). 204 */ 205 #define WITHOUT_TRANSPORT_VERSION(flags) \ 206 ((flags) & (IP4_TUNNEL | \ 207 IP6_TUNNEL | \ 208 TRANSPORT)) 209 210 struct cdev_qp { 211 uint16_t id; 212 uint16_t qp; 213 uint16_t in_flight; 214 uint16_t len; 215 struct rte_crypto_op *buf[MAX_PKT_BURST] __rte_aligned(sizeof(void *)); 216 }; 217 218 struct ipsec_ctx { 219 struct rte_hash *cdev_map; 220 struct sp_ctx *sp4_ctx; 221 struct sp_ctx *sp6_ctx; 222 struct sa_ctx *sa_ctx; 223 uint16_t nb_qps; 224 uint16_t last_qp; 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; 232 }; 233 234 struct cdev_key { 235 uint16_t lcore_id; 236 uint8_t cipher_algo; 237 uint8_t auth_algo; 238 uint8_t aead_algo; 239 }; 240 241 struct socket_ctx { 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; 254 }; 255 256 struct cnt_blk { 257 uint32_t salt; 258 uint64_t iv; 259 uint32_t cnt; 260 } __rte_packed; 261 262 /* Socket ctx */ 263 extern struct socket_ctx socket_ctx[NB_SOCKETS]; 264 265 void 266 ipsec_poll_mode_worker(void); 267 268 int 269 ipsec_launch_one_lcore(void *args); 270 271 extern struct ipsec_sa *sa_out; 272 extern uint32_t nb_sa_out; 273 274 extern struct ipsec_sa *sa_in; 275 extern uint32_t nb_sa_in; 276 277 uint16_t 278 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 279 uint16_t nb_pkts, uint16_t len); 280 281 uint16_t 282 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 283 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len); 284 285 uint16_t 286 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 287 uint16_t len); 288 289 uint16_t 290 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[], 291 uint16_t len); 292 293 void 294 ipsec_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf); 295 296 void 297 ipsec_cqp_process(struct ipsec_ctx *ctx, struct ipsec_traffic *trf); 298 299 static inline uint16_t 300 ipsec_metadata_size(void) 301 { 302 return sizeof(struct ipsec_mbuf_metadata); 303 } 304 305 static inline struct ipsec_mbuf_metadata * 306 get_priv(struct rte_mbuf *m) 307 { 308 return rte_mbuf_to_priv(m); 309 } 310 311 static inline void * 312 get_cnt_blk(struct rte_mbuf *m) 313 { 314 struct ipsec_mbuf_metadata *priv = get_priv(m); 315 316 return &priv->buf[0]; 317 } 318 319 static inline void * 320 get_aad(struct rte_mbuf *m) 321 { 322 struct ipsec_mbuf_metadata *priv = get_priv(m); 323 324 return &priv->buf[16]; 325 } 326 327 static inline void * 328 get_sym_cop(struct rte_crypto_op *cop) 329 { 330 return (cop + 1); 331 } 332 333 static inline struct rte_ipsec_session * 334 ipsec_get_primary_session(struct ipsec_sa *sa) 335 { 336 return &sa->sessions[IPSEC_SESSION_PRIMARY]; 337 } 338 339 static inline struct rte_ipsec_session * 340 ipsec_get_fallback_session(struct ipsec_sa *sa) 341 { 342 return &sa->sessions[IPSEC_SESSION_FALLBACK]; 343 } 344 345 static inline enum rte_security_session_action_type 346 ipsec_get_action_type(struct ipsec_sa *sa) 347 { 348 struct rte_ipsec_session *ips; 349 ips = ipsec_get_primary_session(sa); 350 return ips->type; 351 } 352 353 int 354 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx); 355 356 void 357 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[], 358 void *sa[], uint16_t nb_pkts); 359 360 void 361 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[], 362 void *sa[], uint16_t nb_pkts); 363 364 void 365 sp4_init(struct socket_ctx *ctx, int32_t socket_id); 366 367 void 368 sp6_init(struct socket_ctx *ctx, int32_t socket_id); 369 370 /* 371 * Search through SP rules for given SPI. 372 * Returns first rule index if found(greater or equal then zero), 373 * or -ENOENT otherwise. 374 */ 375 int 376 sp4_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2], 377 uint32_t mask[2]); 378 int 379 sp6_spi_present(uint32_t spi, int inbound, struct ip_addr ip_addr[2], 380 uint32_t mask[2]); 381 382 /* 383 * Search through SA entries for given SPI. 384 * Returns first entry index if found(greater or equal then zero), 385 * or -ENOENT otherwise. 386 */ 387 int 388 sa_spi_present(struct sa_ctx *sa_ctx, uint32_t spi, int inbound); 389 390 void 391 sa_init(struct socket_ctx *ctx, int32_t socket_id); 392 393 void 394 rt_init(struct socket_ctx *ctx, int32_t socket_id); 395 396 int 397 sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads, 398 uint64_t *tx_offloads); 399 400 int 401 add_dst_ethaddr(uint16_t port, const struct rte_ether_addr *addr); 402 403 void 404 enqueue_cop_burst(struct cdev_qp *cqp); 405 406 int 407 create_lookaside_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa, 408 struct rte_ipsec_session *ips); 409 410 int 411 create_inline_session(struct socket_ctx *skt_ctx, struct ipsec_sa *sa, 412 struct rte_ipsec_session *ips); 413 int 414 check_flow_params(uint16_t fdir_portid, uint8_t fdir_qid); 415 416 int 417 create_ipsec_esp_flow(struct ipsec_sa *sa); 418 419 uint32_t 420 get_nb_crypto_sessions(void); 421 422 #endif /* __IPSEC_H__ */ 423