3 *------------------------------------------------------------------
4 * Copyright (c) 2019 - 2021 Intel and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *------------------------------------------------------------------
19 #include <vlib/vlib.h>
20 #include <vnet/crypto/crypto.h>
22 #include <dpdk/buffer.h>
23 #include <dpdk/device/dpdk.h>
24 #include <dpdk/device/dpdk_priv.h>
26 #include <rte_bus_vdev.h>
27 #include <rte_cryptodev.h>
28 #include <rte_crypto_sym.h>
29 #include <rte_crypto.h>
30 #include <rte_ring_peek_zc.h>
31 #include <rte_config.h>
33 #include "cryptodev.h"
36 #define always_inline static inline
38 #define always_inline static inline __attribute__ ((__always_inline__))
41 #define CRYPTODEV_AAD_OFFSET (offsetof (cryptodev_op_t, aad))
43 #define foreach_vnet_crypto_status_conversion \
44 _ (SUCCESS, COMPLETED) \
45 _ (NOT_PROCESSED, WORK_IN_PROGRESS) \
46 _ (AUTH_FAILED, FAIL_BAD_HMAC) \
47 _ (INVALID_SESSION, FAIL_ENGINE_ERR) \
48 _ (INVALID_ARGS, FAIL_ENGINE_ERR) \
49 _ (ERROR, FAIL_ENGINE_ERR)
51 static const vnet_crypto_op_status_t cryptodev_status_conversion[] = {
52 #define _(a, b) VNET_CRYPTO_OP_STATUS_##b,
53 foreach_vnet_crypto_status_conversion
57 static_always_inline rte_iova_t
58 cryptodev_get_iova (clib_pmalloc_main_t *pm, enum rte_iova_mode mode,
62 if (mode == RTE_IOVA_VA)
63 return (rte_iova_t) pointer_to_uword (data);
65 index = clib_pmalloc_get_page_index (pm, data);
66 return pointer_to_uword (data) - pm->lookup_table[index];
69 static_always_inline void
70 cryptodev_validate_mbuf_chain (vlib_main_t *vm, struct rte_mbuf *mb,
73 struct rte_mbuf *first_mb = mb, *last_mb = mb; /**< last mbuf */
74 /* when input node is not dpdk, mbuf data len is not initialized, for
75 * single buffer it is not a problem since the data length is written
76 * into cryptodev operation. For chained buffer a reference data length
77 * has to be computed through vlib_buffer.
79 * even when input node is dpdk, it is possible chained vlib_buffers
80 * are updated (either added or removed a buffer) but not not mbuf fields.
81 * we have to re-link every mbuf in the chain.
83 u16 data_len = b->current_length +
84 (b->data + b->current_data - rte_pktmbuf_mtod (mb, u8 *));
86 first_mb->nb_segs = 1;
87 first_mb->pkt_len = first_mb->data_len = data_len;
89 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
91 b = vlib_get_buffer (vm, b->next_buffer);
92 mb = rte_mbuf_from_vlib_buffer (b);
93 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
94 rte_pktmbuf_reset (mb);
97 mb->data_len = b->current_length;
98 mb->pkt_len = b->current_length;
99 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
101 if (PREDICT_FALSE (b->ref_count > 1))
103 dpdk_no_cache_mempool_by_buffer_pool_index[b->buffer_pool_index];
107 static_always_inline void
108 crypto_op_init (struct rte_mempool *mempool,
109 void *_arg __attribute__ ((unused)), void *_obj,
110 unsigned i __attribute__ ((unused)))
112 struct rte_crypto_op *op = _obj;
114 op->sess_type = RTE_CRYPTO_OP_WITH_SESSION;
115 op->type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
116 op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
117 op->phys_addr = rte_mempool_virt2iova (_obj);
118 op->mempool = mempool;
121 static_always_inline int
122 cryptodev_frame_linked_algs_enqueue (vlib_main_t *vm,
123 vnet_crypto_async_frame_t *frame,
124 cryptodev_op_type_t op_type)
126 cryptodev_main_t *cmt = &cryptodev_main;
127 clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main;
128 cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index;
129 vnet_crypto_async_frame_elt_t *fe;
130 cryptodev_session_t *sess = 0;
131 cryptodev_op_t **cop;
133 u32 n_enqueue, n_elts;
134 u32 last_key_index = ~0;
136 if (PREDICT_FALSE (frame == 0 || frame->n_elts == 0))
138 n_elts = frame->n_elts;
140 if (PREDICT_FALSE (CRYPTODEV_NB_CRYPTO_OPS - cet->inflight < n_elts))
142 cryptodev_mark_frame_err_status (frame,
143 VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
148 rte_mempool_get_bulk (cet->cop_pool, (void **) cet->cops, n_elts) < 0))
150 cryptodev_mark_frame_err_status (frame,
151 VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
157 bi = frame->buffer_indices;
158 cop[0]->frame = frame;
159 cop[0]->n_elts = n_elts;
163 vlib_buffer_t *b = vlib_get_buffer (vm, bi[0]);
164 struct rte_crypto_sym_op *sop = &cop[0]->sop;
165 i16 crypto_offset = fe->crypto_start_offset;
166 i16 integ_offset = fe->integ_start_offset;
167 u32 offset_diff = crypto_offset - integ_offset;
171 CLIB_PREFETCH (cop[1], sizeof (*cop[1]), STORE);
172 CLIB_PREFETCH (cop[2], sizeof (*cop[2]), STORE);
173 clib_prefetch_load (&fe[1]);
174 clib_prefetch_load (&fe[2]);
176 if (last_key_index != fe->key_index)
178 cryptodev_key_t *key = vec_elt_at_index (cmt->keys, fe->key_index);
179 last_key_index = fe->key_index;
181 if (key->keys[vm->numa_node][op_type] == 0)
184 cryptodev_session_create (vm, last_key_index, 0) < 0))
186 cryptodev_mark_frame_err_status (
187 frame, VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
191 sess = key->keys[vm->numa_node][op_type];
194 sop->m_src = rte_mbuf_from_vlib_buffer (b);
195 sop->m_src->data_off = VLIB_BUFFER_PRE_DATA_SIZE;
197 /* mbuf prepend happens in the tx, but vlib_buffer happens in the nodes,
198 * so we have to manually adjust mbuf data_off here so cryptodev can
199 * correctly compute the data pointer. The prepend here will be later
200 * rewritten by tx. */
201 if (PREDICT_TRUE (fe->integ_start_offset < 0))
203 sop->m_src->data_off += fe->integ_start_offset;
205 crypto_offset = offset_diff;
208 sop->cipher.data.offset = crypto_offset;
209 sop->cipher.data.length = fe->crypto_total_length;
210 sop->auth.data.offset = integ_offset;
211 sop->auth.data.length = fe->crypto_total_length + fe->integ_length_adj;
212 sop->auth.digest.data = fe->digest;
213 sop->auth.digest.phys_addr =
214 cryptodev_get_iova (pm, cmt->iova_mode, fe->digest);
215 if (PREDICT_FALSE (fe->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS))
216 cryptodev_validate_mbuf_chain (vm, sop->m_src, b);
218 /* for input nodes that are not dpdk-input, it is possible the mbuf
219 * was updated before as one of the chained mbufs. Setting nb_segs
220 * to 1 here to prevent the cryptodev PMD to access potentially
221 * invalid m_src->next pointers.
223 sop->m_src->nb_segs = 1;
224 clib_memcpy_fast (cop[0]->iv, fe->iv, 16);
231 n_enqueue = rte_cryptodev_enqueue_burst (cet->cryptodev_id, cet->cryptodev_q,
232 (struct rte_crypto_op **) cet->cops,
234 ASSERT (n_enqueue == frame->n_elts);
235 cet->inflight += n_enqueue;
240 static_always_inline int
241 cryptodev_frame_aead_enqueue (vlib_main_t *vm,
242 vnet_crypto_async_frame_t *frame,
243 cryptodev_op_type_t op_type, u8 aad_len)
245 cryptodev_main_t *cmt = &cryptodev_main;
246 clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main;
247 cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index;
248 vnet_crypto_async_frame_elt_t *fe;
249 cryptodev_session_t *sess = 0;
250 cryptodev_op_t **cop;
252 u32 n_enqueue = 0, n_elts;
253 u32 last_key_index = ~0;
255 if (PREDICT_FALSE (frame == 0 || frame->n_elts == 0))
257 n_elts = frame->n_elts;
259 if (PREDICT_FALSE (CRYPTODEV_MAX_INFLIGHT - cet->inflight < n_elts))
261 cryptodev_mark_frame_err_status (frame,
262 VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
267 rte_mempool_get_bulk (cet->cop_pool, (void **) cet->cops, n_elts) < 0))
269 cryptodev_mark_frame_err_status (frame,
270 VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
276 bi = frame->buffer_indices;
277 cop[0]->frame = frame;
278 cop[0]->n_elts = n_elts;
282 vlib_buffer_t *b = vlib_get_buffer (vm, bi[0]);
283 struct rte_crypto_sym_op *sop = &cop[0]->sop;
284 u16 crypto_offset = fe->crypto_start_offset;
288 CLIB_PREFETCH (cop[1], sizeof (*cop[1]), STORE);
289 CLIB_PREFETCH (cop[2], sizeof (*cop[2]), STORE);
290 clib_prefetch_load (&fe[1]);
291 clib_prefetch_load (&fe[2]);
293 if (last_key_index != fe->key_index)
295 cryptodev_key_t *key = vec_elt_at_index (cmt->keys, fe->key_index);
297 last_key_index = fe->key_index;
298 if (key->keys[vm->numa_node][op_type] == 0)
300 if (PREDICT_FALSE (cryptodev_session_create (vm, last_key_index,
303 cryptodev_mark_frame_err_status (
304 frame, VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
308 else if (PREDICT_FALSE (
309 #if RTE_VERSION >= RTE_VERSION_NUM(22, 11, 0, 0)
310 rte_cryptodev_sym_session_opaque_data_get (
311 key->keys[vm->numa_node][op_type]) != (u64) aad_len
313 key->keys[vm->numa_node][op_type]->opaque_data != aad_len
317 cryptodev_sess_handler (vm, VNET_CRYPTO_KEY_OP_DEL,
318 fe->key_index, aad_len);
319 if (PREDICT_FALSE (cryptodev_session_create (vm, last_key_index,
322 cryptodev_mark_frame_err_status (
323 frame, VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
328 sess = key->keys[vm->numa_node][op_type];
331 sop->m_src = rte_mbuf_from_vlib_buffer (b);
332 sop->m_src->data_off = VLIB_BUFFER_PRE_DATA_SIZE;
334 /* mbuf prepend happens in the tx, but vlib_buffer happens in the nodes,
335 * so we have to manually adjust mbuf data_off here so cryptodev can
336 * correctly compute the data pointer. The prepend here will be later
337 * rewritten by tx. */
338 if (PREDICT_FALSE (fe->crypto_start_offset < 0))
340 rte_pktmbuf_prepend (sop->m_src, -fe->crypto_start_offset);
345 sop->aead.aad.data = cop[0]->aad;
346 sop->aead.aad.phys_addr = cop[0]->op.phys_addr + CRYPTODEV_AAD_OFFSET;
347 sop->aead.data.length = fe->crypto_total_length;
348 sop->aead.data.offset = crypto_offset;
349 sop->aead.digest.data = fe->tag;
350 sop->aead.digest.phys_addr =
351 cryptodev_get_iova (pm, cmt->iova_mode, fe->tag);
352 if (PREDICT_FALSE (fe->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS))
353 cryptodev_validate_mbuf_chain (vm, sop->m_src, b);
355 /* for input nodes that are not dpdk-input, it is possible the mbuf
356 * was updated before as one of the chained mbufs. Setting nb_segs
357 * to 1 here to prevent the cryptodev PMD to access potentially
358 * invalid m_src->next pointers.
360 sop->m_src->nb_segs = 1;
361 clib_memcpy_fast (cop[0]->iv, fe->iv, 12);
362 clib_memcpy_fast (cop[0]->aad, fe->aad, aad_len);
369 n_enqueue = rte_cryptodev_enqueue_burst (cet->cryptodev_id, cet->cryptodev_q,
370 (struct rte_crypto_op **) cet->cops,
372 ASSERT (n_enqueue == frame->n_elts);
373 cet->inflight += n_enqueue;
378 static_always_inline u16
379 cryptodev_ring_deq (struct rte_ring *r, cryptodev_op_t **cops)
383 n = rte_ring_dequeue_bulk_start (r, (void **) cops, 1, 0);
384 rte_ring_dequeue_finish (r, 0);
389 if (rte_ring_count (r) < n)
392 n_elts = rte_ring_sc_dequeue_bulk (r, (void **) cops, n, 0);
393 ASSERT (n_elts == n);
398 static_always_inline vnet_crypto_async_frame_t *
399 cryptodev_frame_dequeue (vlib_main_t *vm, u32 *nb_elts_processed,
400 u32 *enqueue_thread_idx)
402 cryptodev_main_t *cmt = &cryptodev_main;
403 cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index;
404 cryptodev_op_t **cop = cet->cops;
405 vnet_crypto_async_frame_elt_t *fe;
406 vnet_crypto_async_frame_t *frame;
407 u32 n_elts, n_completed_ops = rte_ring_count (cet->ring);
408 u32 ss0 = 0, ss1 = 0, ss2 = 0, ss3 = 0; /* sum of status */
412 n_elts = rte_cryptodev_dequeue_burst (
413 cet->cryptodev_id, cet->cryptodev_q,
414 (struct rte_crypto_op **) cet->cops, VNET_CRYPTO_FRAME_SIZE);
418 cet->inflight -= n_elts;
419 n_completed_ops += n_elts;
421 rte_ring_sp_enqueue_burst (cet->ring, (void **) cet->cops, n_elts,
426 if (PREDICT_FALSE (n_completed_ops == 0))
429 n_elts = cryptodev_ring_deq (cet->ring, cop);
433 frame = cop[0]->frame;
438 ss0 |= fe[0].status = cryptodev_status_conversion[cop[0]->op.status];
439 ss1 |= fe[1].status = cryptodev_status_conversion[cop[1]->op.status];
440 ss2 |= fe[2].status = cryptodev_status_conversion[cop[2]->op.status];
441 ss3 |= fe[3].status = cryptodev_status_conversion[cop[3]->op.status];
450 ss0 |= fe[0].status = cryptodev_status_conversion[cop[0]->op.status];
456 frame->state = (ss0 | ss1 | ss2 | ss3) == VNET_CRYPTO_OP_STATUS_COMPLETED ?
457 VNET_CRYPTO_FRAME_STATE_SUCCESS :
458 VNET_CRYPTO_FRAME_STATE_ELT_ERROR;
460 rte_mempool_put_bulk (cet->cop_pool, (void **) cet->cops, frame->n_elts);
461 *nb_elts_processed = frame->n_elts;
462 *enqueue_thread_idx = frame->enqueue_thread_index;
466 static_always_inline int
467 cryptodev_enqueue_aead_aad_0_enc (vlib_main_t *vm,
468 vnet_crypto_async_frame_t *frame)
470 return cryptodev_frame_aead_enqueue (vm, frame, CRYPTODEV_OP_TYPE_ENCRYPT,
473 static_always_inline int
474 cryptodev_enqueue_aead_aad_8_enc (vlib_main_t *vm,
475 vnet_crypto_async_frame_t *frame)
477 return cryptodev_frame_aead_enqueue (vm, frame, CRYPTODEV_OP_TYPE_ENCRYPT,
480 static_always_inline int
481 cryptodev_enqueue_aead_aad_12_enc (vlib_main_t *vm,
482 vnet_crypto_async_frame_t *frame)
484 return cryptodev_frame_aead_enqueue (vm, frame, CRYPTODEV_OP_TYPE_ENCRYPT,
488 static_always_inline int
489 cryptodev_enqueue_aead_aad_0_dec (vlib_main_t *vm,
490 vnet_crypto_async_frame_t *frame)
492 return cryptodev_frame_aead_enqueue (vm, frame, CRYPTODEV_OP_TYPE_DECRYPT,
495 static_always_inline int
496 cryptodev_enqueue_aead_aad_8_dec (vlib_main_t *vm,
497 vnet_crypto_async_frame_t *frame)
499 return cryptodev_frame_aead_enqueue (vm, frame, CRYPTODEV_OP_TYPE_DECRYPT,
502 static_always_inline int
503 cryptodev_enqueue_aead_aad_12_dec (vlib_main_t *vm,
504 vnet_crypto_async_frame_t *frame)
506 return cryptodev_frame_aead_enqueue (vm, frame, CRYPTODEV_OP_TYPE_DECRYPT,
510 static_always_inline int
511 cryptodev_enqueue_linked_alg_enc (vlib_main_t *vm,
512 vnet_crypto_async_frame_t *frame)
514 return cryptodev_frame_linked_algs_enqueue (vm, frame,
515 CRYPTODEV_OP_TYPE_ENCRYPT);
518 static_always_inline int
519 cryptodev_enqueue_linked_alg_dec (vlib_main_t *vm,
520 vnet_crypto_async_frame_t *frame)
522 return cryptodev_frame_linked_algs_enqueue (vm, frame,
523 CRYPTODEV_OP_TYPE_DECRYPT);
527 cryptodev_register_cop_hdl (vlib_main_t *vm, u32 eidx)
529 cryptodev_main_t *cmt = &cryptodev_main;
530 cryptodev_engine_thread_t *cet;
531 struct rte_cryptodev_sym_capability_idx cap_auth_idx;
532 struct rte_cryptodev_sym_capability_idx cap_cipher_idx;
533 struct rte_cryptodev_sym_capability_idx cap_aead_idx;
535 clib_error_t *error = 0;
538 vec_foreach (cet, cmt->per_thread_data)
540 u32 thread_index = cet - cmt->per_thread_data;
541 u32 numa = vlib_get_main_by_index (thread_index)->numa_node;
542 name = format (0, "vpp_cop_pool_%u_%u", numa, thread_index);
543 cet->cop_pool = rte_mempool_create (
544 (char *) name, CRYPTODEV_NB_CRYPTO_OPS, sizeof (cryptodev_op_t), 0,
545 sizeof (struct rte_crypto_op_pool_private), NULL, NULL, crypto_op_init,
546 NULL, vm->numa_node, 0);
549 error = clib_error_return (
550 0, "Failed to create cryptodev op pool %s", name);
556 name = format (0, "frames_ring_%u_%u", numa, thread_index);
558 rte_ring_create ((char *) name, CRYPTODEV_NB_CRYPTO_OPS, vm->numa_node,
559 RING_F_SP_ENQ | RING_F_SC_DEQ);
562 error = clib_error_return (
563 0, "Failed to create cryptodev op pool %s", name);
569 vec_validate (cet->cops, VNET_CRYPTO_FRAME_SIZE - 1);
572 #define _(a, b, c, d, e, f, g) \
573 cap_aead_idx.type = RTE_CRYPTO_SYM_XFORM_AEAD; \
574 cap_aead_idx.algo.aead = RTE_CRYPTO_##b##_##c; \
575 if (cryptodev_check_cap_support (&cap_aead_idx, g, e, f)) \
577 vnet_crypto_register_enqueue_handler ( \
578 vm, eidx, VNET_CRYPTO_OP_##a##_TAG##e##_AAD##f##_ENC, \
579 cryptodev_enqueue_aead_aad_##f##_enc); \
580 vnet_crypto_register_enqueue_handler ( \
581 vm, eidx, VNET_CRYPTO_OP_##a##_TAG##e##_AAD##f##_DEC, \
582 cryptodev_enqueue_aead_aad_##f##_dec); \
585 foreach_vnet_aead_crypto_conversion
588 #define _(a, b, c, d, e) \
589 cap_auth_idx.type = RTE_CRYPTO_SYM_XFORM_AUTH; \
590 cap_auth_idx.algo.auth = RTE_CRYPTO_AUTH_##d##_HMAC; \
591 cap_cipher_idx.type = RTE_CRYPTO_SYM_XFORM_CIPHER; \
592 cap_cipher_idx.algo.cipher = RTE_CRYPTO_CIPHER_##b; \
593 if (cryptodev_check_cap_support (&cap_cipher_idx, c, -1, -1) && \
594 cryptodev_check_cap_support (&cap_auth_idx, -1, e, -1)) \
596 vnet_crypto_register_enqueue_handler ( \
597 vm, eidx, VNET_CRYPTO_OP_##a##_##d##_TAG##e##_ENC, \
598 cryptodev_enqueue_linked_alg_enc); \
599 vnet_crypto_register_enqueue_handler ( \
600 vm, eidx, VNET_CRYPTO_OP_##a##_##d##_TAG##e##_DEC, \
601 cryptodev_enqueue_linked_alg_dec); \
604 foreach_cryptodev_link_async_alg
608 vnet_crypto_register_dequeue_handler (vm, eidx, cryptodev_frame_dequeue);
613 vec_foreach (cet, cmt->per_thread_data)
616 rte_ring_free (cet->ring);
619 rte_mempool_free (cet->cop_pool);