FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
ipsec.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Intel and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef __DPDK_IPSEC_H__
16 #define __DPDK_IPSEC_H__
17 
18 #include <vnet/vnet.h>
19 #include <vppinfra/cache.h>
20 #include <vnet/ipsec/ipsec.h>
21 
22 #undef always_inline
23 #include <rte_config.h>
24 #include <rte_crypto.h>
25 #include <rte_cryptodev.h>
26 
27 #if CLIB_DEBUG > 0
28 #define always_inline static inline
29 #else
30 #define always_inline static inline __attribute__ ((__always_inline__))
31 #endif
32 
33 #define foreach_dpdk_crypto_input_next \
34  _(DROP, "error-drop") \
35  _(IP4_LOOKUP, "ip4-lookup") \
36  _(IP6_LOOKUP, "ip6-lookup") \
37  _(INTERFACE_OUTPUT, "interface-output") \
38  _(DECRYPT_POST, "dpdk-esp-decrypt-post")
39 
40 typedef enum
41 {
42 #define _(f,s) DPDK_CRYPTO_INPUT_NEXT_##f,
44 #undef _
47 
48 #define MAX_QP_PER_LCORE 16
49 
50 typedef struct
51 {
53  u32 iv[2];
56 
57 typedef struct
58 {
60  dpdk_gcm_cnt_blk cb __attribute__ ((aligned (16)));
61  u8 aad[16];
62  u8 icv[32];
64 
65 typedef struct
66 {
68  struct rte_crypto_op **ops;
69  u16 cipher_resource_idx[IPSEC_CRYPTO_N_ALG];
70  u16 auth_resource_idx[IPSEC_INTEG_N_ALG];
72 } crypto_worker_main_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
73 
74 typedef struct
75 {
76  char *name;
77  enum rte_crypto_sym_xform_type type;
85 } crypto_alg_t __attribute__ ((aligned (8)));
86 
87 typedef struct
88 {
91  u8 cipher_support[IPSEC_CRYPTO_N_ALG];
92  u8 auth_support[IPSEC_INTEG_N_ALG];
96  const char *name;
99 } crypto_dev_t;
100 
101 typedef struct
102 {
103  const char *name;
105 } crypto_drv_t;
106 
107 typedef struct
108 {
110  u8 remove;
115  u16 inflights[2];
117  u16 __unused;
118  struct rte_crypto_op *ops[VLIB_FRAME_SIZE];
120 } crypto_resource_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
121 
122 typedef struct
123 {
125  struct rte_cryptodev_sym_session *session;
127 
128 typedef struct
129 {
130  struct rte_cryptodev_sym_session *session;
133 
134 typedef struct
135 {
136  /* Required for vec_validate_aligned */
137  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
138  struct rte_mempool *crypto_op;
139  struct rte_mempool *session_h;
140  struct rte_mempool **session_drv;
148 } crypto_data_t;
149 
150 typedef struct
151 {
159  u64 session_timeout; /* nsec */
162 
164 
165 static const u8 pad_data[] =
166  { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 0 };
167 
168 void crypto_auto_placement (void);
169 
170 clib_error_t *create_sym_session (struct rte_cryptodev_sym_session **session,
171  u32 sa_idx, crypto_resource_t * res,
172  crypto_worker_main_t * cwm, u8 is_outbound);
173 
176 {
177  const u32 align = 4;
178  u32 op_size =
179  sizeof (struct rte_crypto_op) + sizeof (struct rte_crypto_sym_op);
180 
181  return ((op_size + align - 1) & ~(align - 1)) + sizeof (dpdk_op_priv_t);
182 }
183 
186 {
187  const u32 align = 16;
188  u32 offset;
189 
190  offset = sizeof (struct rte_crypto_op) + sizeof (struct rte_crypto_sym_op);
191  offset = (offset + align - 1) & ~(align - 1);
192 
193  return offset;
194 }
195 
197 crypto_op_get_priv (struct rte_crypto_op * op)
198 {
199  return (dpdk_op_priv_t *) (((u8 *) op) + crypto_op_get_priv_offset ());
200 }
201 
202 
204 add_session_by_drv_and_sa_idx (struct rte_cryptodev_sym_session *session,
205  crypto_data_t * data, u32 drv_id, u32 sa_idx)
206 {
210  sbd = vec_elt_at_index (data->session_by_drv_id_and_sa_index, sa_idx);
211  sbd->dev_mask |= 1L << drv_id;
212  sbd->session = session;
213 }
214 
215 static_always_inline struct rte_cryptodev_sym_session *
217 {
218  crypto_session_by_drv_t *sess_by_sa;
219  if (_vec_len (data->session_by_drv_id_and_sa_index) <= sa_idx)
220  return NULL;
221  sess_by_sa =
223  return (sess_by_sa->dev_mask & (1L << drv_id)) ? sess_by_sa->session : NULL;
224 }
225 
227 crypto_get_session (struct rte_cryptodev_sym_session ** session,
228  u32 sa_idx,
229  crypto_resource_t * res,
230  crypto_worker_main_t * cwm, u8 is_outbound)
231 {
233  crypto_data_t *data;
234  struct rte_cryptodev_sym_session *sess;
235 
236  data = vec_elt_at_index (dcm->data, res->numa);
237  sess = get_session_by_drv_and_sa_idx (data, res->drv_id, sa_idx);
238 
239  if (PREDICT_FALSE (!sess))
240  return create_sym_session (session, sa_idx, res, cwm, is_outbound);
241 
242  session[0] = sess;
243 
244  return NULL;
245 }
246 
249 {
250  u16 cipher_res = cwm->cipher_resource_idx[sa->crypto_alg];
251  u16 auth_res = cwm->auth_resource_idx[sa->integ_alg];
252  u8 is_aead;
253 
254  /* Not allowed to setup SA with no-aead-cipher/NULL or NULL/NULL */
255 
256  is_aead = ((sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128) ||
257  (sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_192) ||
258  (sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_256));
259 
260  if (sa->crypto_alg == IPSEC_CRYPTO_ALG_NONE)
261  return auth_res;
262 
263  if (cipher_res == auth_res)
264  return cipher_res;
265 
266  if (is_aead)
267  return cipher_res;
268 
269  return (u16) ~ 0;
270 }
271 
273 crypto_alloc_ops (u8 numa, struct rte_crypto_op ** ops, u32 n)
274 {
276  crypto_data_t *data = vec_elt_at_index (dcm->data, numa);
277  i32 ret;
278 
279  ret = rte_mempool_get_bulk (data->crypto_op, (void **) ops, n);
280 
281  /* *INDENT-OFF* */
282  data->crypto_op_get_failed += ! !ret;
283  /* *INDENT-ON* */
284 
285  return ret;
286 }
287 
289 crypto_free_ops (u8 numa, struct rte_crypto_op **ops, u32 n)
290 {
292  crypto_data_t *data = vec_elt_at_index (dcm->data, numa);
293 
294  if (!n)
295  return;
296 
297  rte_mempool_put_bulk (data->crypto_op, (void **) ops, n);
298 }
299 
302  u32 node_index, u32 error, u8 numa)
303 {
305  crypto_resource_t *res;
306  u16 *res_idx;
307 
308  /* *INDENT-OFF* */
309  vec_foreach (res_idx, cwm->resource_idx)
310  {
311  u16 enq;
312  res = vec_elt_at_index (dcm->resource, res_idx[0]);
313 
314  if (!res->n_ops)
315  continue;
316 
317  enq = rte_cryptodev_enqueue_burst (res->dev_id, res->qp_id + outbound,
318  res->ops, res->n_ops);
319  res->inflights[outbound] += enq;
320 
321  if (PREDICT_FALSE (enq < res->n_ops))
322  {
323  crypto_free_ops (numa, &res->ops[enq], res->n_ops - enq);
324  vlib_buffer_free (vm, &res->bi[enq], res->n_ops - enq);
325 
326  vlib_node_increment_counter (vm, node_index, error,
327  res->n_ops - enq);
328  }
329  res->n_ops = 0;
330  }
331  /* *INDENT-ON* */
332 }
333 
335 crypto_set_icb (dpdk_gcm_cnt_blk * icb, u32 salt, u32 seq, u32 seq_hi)
336 {
337  icb->salt = salt;
338  icb->iv[0] = seq;
339  icb->iv[1] = seq_hi;
340 }
341 
343 crypto_op_setup (u8 is_aead, struct rte_mbuf *mb0,
344  struct rte_crypto_op *op, void *session,
345  u32 cipher_off, u32 cipher_len,
346  u32 auth_off, u32 auth_len,
347  u8 * aad, u8 * digest, u64 digest_paddr)
348 {
349  struct rte_crypto_sym_op *sym_op;
350 
351  sym_op = (struct rte_crypto_sym_op *) (op + 1);
352 
353  sym_op->m_src = mb0;
354  sym_op->session = session;
355 
356  if (is_aead)
357  {
358  sym_op->aead.data.offset = cipher_off;
359  sym_op->aead.data.length = cipher_len;
360 
361  sym_op->aead.aad.data = aad;
362  sym_op->aead.aad.phys_addr =
363  op->phys_addr + (uintptr_t) aad - (uintptr_t) op;
364 
365  sym_op->aead.digest.data = digest;
366  sym_op->aead.digest.phys_addr = digest_paddr;
367  }
368  else
369  {
370  sym_op->cipher.data.offset = cipher_off;
371  sym_op->cipher.data.length = cipher_len;
372 
373  sym_op->auth.data.offset = auth_off;
374  sym_op->auth.data.length = auth_len;
375 
376  sym_op->auth.digest.data = digest;
377  sym_op->auth.digest.phys_addr = digest_paddr;
378  }
379 }
380 
381 #endif /* __DPDK_IPSEC_H__ */
382 
383 /*
384  * fd.io coding-style-patch-verification: ON
385  *
386  * Local Variables:
387  * eval: (c-set-style "gnu")
388  * End:
389  */
u32 alg
Definition: ipsec.h:78
static_always_inline void crypto_op_setup(u8 is_aead, struct rte_mbuf *mb0, struct rte_crypto_op *op, void *session, u32 cipher_off, u32 cipher_len, u32 auth_off, u32 auth_len, u8 *aad, u8 *digest, u64 digest_paddr)
Definition: ipsec.h:343
u8 pad[3]
log2 (size of the packing page block)
Definition: bihash_doc.h:61
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
clib_error_t * create_sym_session(struct rte_cryptodev_sym_session **session, u32 sa_idx, crypto_resource_t *res, crypto_worker_main_t *cwm, u8 is_outbound)
Definition: ipsec.c:319
static void vlib_buffer_free(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Free buffers Frees the entire buffer chain for each buffer.
Definition: buffer_funcs.h:547
#define foreach_dpdk_crypto_input_next
Definition: ipsec.h:33
u8 numa
Definition: ipsec.h:94
unsigned long u64
Definition: types.h:89
u64 crypto_op_get_failed
Definition: ipsec.h:143
#define NULL
Definition: clib.h:57
u64 session_h_failed
Definition: ipsec.h:144
static_always_inline i32 crypto_alloc_ops(u8 numa, struct rte_crypto_op **ops, u32 n)
Definition: ipsec.h:273
ipsec_integ_alg_t integ_alg
Definition: ipsec.h:121
static_always_inline void crypto_set_icb(dpdk_gcm_cnt_blk *icb, u32 salt, u32 seq, u32 seq_hi)
Definition: ipsec.h:335
static_always_inline u32 crypto_op_get_priv_offset(void)
Definition: ipsec.h:185
struct rte_cryptodev_sym_session * session
Definition: ipsec.h:125
u8 disabled
Definition: ipsec.h:83
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:448
static_always_inline void crypto_enqueue_ops(vlib_main_t *vm, crypto_worker_main_t *cwm, u8 outbound, u32 node_index, u32 error, u8 numa)
Definition: ipsec.h:301
unsigned char u8
Definition: types.h:56
dpdk_crypto_main_t dpdk_crypto_main
Definition: ipsec.c:24
u32 bi[VLIB_FRAME_SIZE]
Definition: ipsec.h:119
u16 * devs
Definition: ipsec.h:104
u16 * resource_idx
Definition: ipsec.h:67
static_always_inline clib_error_t * crypto_get_session(struct rte_cryptodev_sym_session **session, u32 sa_idx, crypto_resource_t *res, crypto_worker_main_t *cwm, u8 is_outbound)
Definition: ipsec.h:227
static_always_inline void crypto_free_ops(u8 numa, struct rte_crypto_op **ops, u32 n)
Definition: ipsec.h:289
#define static_always_inline
Definition: clib.h:95
u16 cipher_resource_idx[IPSEC_CRYPTO_N_ALG]
Definition: ipsec.h:69
u8 resources
Definition: ipsec.h:84
crypto_drv_t * drv
Definition: ipsec.h:158
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
u8 drv_id
Definition: ipsec.h:93
u16 * free_resources
Definition: ipsec.h:89
unsigned int u32
Definition: types.h:88
crypto_alg_t * auth_algs
Definition: ipsec.h:156
#define VLIB_FRAME_SIZE
Definition: node.h:382
u32 iv[2]
Definition: ipsec.h:53
u8 trunc_size
Definition: ipsec.h:81
static_always_inline void add_session_by_drv_and_sa_idx(struct rte_cryptodev_sym_session *session, crypto_data_t *data, u32 drv_id, u32 sa_idx)
Definition: ipsec.h:204
u32 next
Definition: ipsec.h:59
struct rte_cryptodev_sym_session * session
Definition: ipsec.h:130
void crypto_auto_placement(void)
Definition: ipsec.c:732
clib_spinlock_t lockp
Definition: ipsec.h:147
u16 * used_resources
Definition: ipsec.h:90
crypto_alg_t * cipher_algs
Definition: ipsec.h:155
unsigned short u16
Definition: types.h:57
const char * name
Definition: ipsec.h:103
u64 features
Definition: ipsec.h:98
#define PREDICT_FALSE(x)
Definition: clib.h:107
u64 session_timeout
Definition: ipsec.h:159
static_always_inline u32 crypto_op_len(void)
Definition: ipsec.h:175
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1176
struct rte_mempool ** session_drv
Definition: ipsec.h:140
crypto_session_by_drv_t * session_by_drv_id_and_sa_index
Definition: ipsec.h:146
vlib_main_t * vm
Definition: buffer.c:294
crypto_session_disposal_t * session_disposal
Definition: ipsec.h:141
dpdk_crypto_input_next_t
Definition: ipsec.h:40
u16 id
Definition: ipsec.h:95
u8 iv_len
Definition: ipsec.h:80
signed int i32
Definition: types.h:77
struct rte_mempool * crypto_op
Definition: ipsec.h:138
u32 max_qp
Definition: ipsec.h:97
u16 inflights[2]
Definition: ipsec.h:115
crypto_worker_main_t * workers_main
Definition: ipsec.h:152
u8 boundary
Definition: ipsec.h:82
crypto_resource_t * resource
Definition: ipsec.h:154
struct rte_mempool * session_h
Definition: ipsec.h:139
char * name
Definition: ipsec.h:76
u64 * session_drv_failed
Definition: ipsec.h:145
u64 uword
Definition: types.h:112
uword * session_by_sa_index
Definition: ipsec.h:142
const char * name
Definition: ipsec.h:96
struct rte_crypto_op ** ops
Definition: ipsec.h:68
struct clib_bihash_value offset
template key/value backing page structure
crypto_dev_t * dev
Definition: ipsec.h:153
static_always_inline u16 get_resource(crypto_worker_main_t *cwm, ipsec_sa_t *sa)
Definition: ipsec.h:248
crypto_data_t * data
Definition: ipsec.h:157
ipsec_crypto_alg_t crypto_alg
Definition: ipsec.h:117
u16 auth_resource_idx[IPSEC_INTEG_N_ALG]
Definition: ipsec.h:70
#define vec_foreach(var, vec)
Vector iterator.
static_always_inline struct rte_cryptodev_sym_session * get_session_by_drv_and_sa_idx(crypto_data_t *data, u32 drv_id, u32 sa_idx)
Definition: ipsec.h:216
u8 key_len
Definition: ipsec.h:79
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
struct rte_crypto_op * ops[VLIB_FRAME_SIZE]
Definition: ipsec.h:118
static_always_inline dpdk_op_priv_t * crypto_op_get_priv(struct rte_crypto_op *op)
Definition: ipsec.h:197