2 *------------------------------------------------------------------
3 * Copyright (c) 2020 Intel and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #include <vlib/vlib.h>
19 #include <vnet/plugin/plugin.h>
20 #include <vnet/crypto/crypto.h>
21 #include <vnet/vnet.h>
22 #include <vpp/app/version.h>
24 #include <dpdk/buffer.h>
25 #include <dpdk/device/dpdk.h>
26 #include <dpdk/device/dpdk_priv.h>
27 #include <rte_bus_vdev.h>
28 #include <rte_cryptodev.h>
29 #include <rte_crypto_sym.h>
30 #include <rte_crypto.h>
31 #include <rte_cryptodev_pmd.h>
32 #include <rte_config.h>
34 #define CRYPTODEV_NB_CRYPTO_OPS 1024
35 #define CRYPTODEV_NB_SESSION 10240
36 #define CRYPTODEV_DEF_DRIVE crypto_aesni_mb
38 #define CRYPTODEV_IV_OFFSET (offsetof (cryptodev_op_t, iv))
39 #define CRYPTODEV_AAD_OFFSET (offsetof (cryptodev_op_t, aad))
40 #define CRYPTODEV_DIGEST_OFFSET (offsetof (cryptodev_op_t, digest))
42 /* VNET_CRYPTO_ALGO, TYPE, DPDK_CRYPTO_ALGO, IV_LEN, TAG_LEN, AAD_LEN */
43 #define foreach_vnet_aead_crypto_conversion \
44 _(AES_128_GCM, AEAD, AES_GCM, 12, 16, 8) \
45 _(AES_128_GCM, AEAD, AES_GCM, 12, 16, 12) \
46 _(AES_192_GCM, AEAD, AES_GCM, 12, 16, 8) \
47 _(AES_192_GCM, AEAD, AES_GCM, 12, 16, 12) \
48 _(AES_256_GCM, AEAD, AES_GCM, 12, 16, 8) \
49 _(AES_256_GCM, AEAD, AES_GCM, 12, 16, 12)
52 * crypto (alg, cryptodev_alg), hash (alg, digest-size)
54 #define foreach_cryptodev_link_async_alg \
55 _ (AES_128_CBC, AES_CBC, SHA1, 12) \
56 _ (AES_192_CBC, AES_CBC, SHA1, 12) \
57 _ (AES_256_CBC, AES_CBC, SHA1, 12) \
58 _ (AES_128_CBC, AES_CBC, SHA224, 14) \
59 _ (AES_192_CBC, AES_CBC, SHA224, 14) \
60 _ (AES_256_CBC, AES_CBC, SHA224, 14) \
61 _ (AES_128_CBC, AES_CBC, SHA256, 16) \
62 _ (AES_192_CBC, AES_CBC, SHA256, 16) \
63 _ (AES_256_CBC, AES_CBC, SHA256, 16) \
64 _ (AES_128_CBC, AES_CBC, SHA384, 24) \
65 _ (AES_192_CBC, AES_CBC, SHA384, 24) \
66 _ (AES_256_CBC, AES_CBC, SHA384, 24) \
67 _ (AES_128_CBC, AES_CBC, SHA512, 32) \
68 _ (AES_192_CBC, AES_CBC, SHA512, 32) \
69 _ (AES_256_CBC, AES_CBC, SHA512, 32)
71 #define foreach_vnet_crypto_status_conversion \
72 _(SUCCESS, COMPLETED) \
73 _(NOT_PROCESSED, WORK_IN_PROGRESS) \
74 _(AUTH_FAILED, FAIL_BAD_HMAC) \
75 _(INVALID_SESSION, FAIL_ENGINE_ERR) \
76 _(INVALID_ARGS, FAIL_ENGINE_ERR) \
77 _(ERROR, FAIL_ENGINE_ERR)
79 static const vnet_crypto_op_status_t cryptodev_status_conversion[] = {
80 #define _(a, b) VNET_CRYPTO_OP_STATUS_##b,
81 foreach_vnet_crypto_status_conversion
87 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
88 struct rte_crypto_op op;
89 struct rte_crypto_sym_op sop;
92 vnet_crypto_async_frame_t *frame;
98 CRYPTODEV_OP_TYPE_ENCRYPT = 0,
99 CRYPTODEV_OP_TYPE_DECRYPT,
100 CRYPTODEV_N_OP_TYPES,
101 } cryptodev_op_type_t;
105 struct rte_cryptodev_sym_session *keys[CRYPTODEV_N_OP_TYPES];
117 struct rte_mempool *cop_pool;
118 struct rte_mempool *sess_pool;
119 struct rte_mempool *sess_priv_pool;
120 } cryptodev_numa_data_t;
124 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
128 cryptodev_op_t **cops;
129 struct rte_ring *ring;
130 } cryptodev_engine_thread_t;
134 cryptodev_numa_data_t *per_numa_data;
135 cryptodev_key_t *keys;
136 cryptodev_engine_thread_t *per_thread_data;
137 cryptodev_inst_t *cryptodev_inst;
138 clib_bitmap_t *active_cdev_inst_mask;
139 clib_spinlock_t tlock;
142 cryptodev_main_t cryptodev_main;
145 prepare_aead_xform (struct rte_crypto_sym_xform *xform,
146 cryptodev_op_type_t op_type,
147 const vnet_crypto_key_t * key, u32 aad_len)
149 struct rte_crypto_aead_xform *aead_xform = &xform->aead;
150 memset (xform, 0, sizeof (*xform));
151 xform->type = RTE_CRYPTO_SYM_XFORM_AEAD;
154 if (key->alg != VNET_CRYPTO_ALG_AES_128_GCM &&
155 key->alg != VNET_CRYPTO_ALG_AES_192_GCM &&
156 key->alg != VNET_CRYPTO_ALG_AES_256_GCM)
159 aead_xform->algo = RTE_CRYPTO_AEAD_AES_GCM;
160 aead_xform->op = (op_type == CRYPTODEV_OP_TYPE_ENCRYPT) ?
161 RTE_CRYPTO_AEAD_OP_ENCRYPT : RTE_CRYPTO_AEAD_OP_DECRYPT;
162 aead_xform->aad_length = aad_len;
163 aead_xform->digest_length = 16;
164 aead_xform->iv.offset = CRYPTODEV_IV_OFFSET;
165 aead_xform->iv.length = 12;
166 aead_xform->key.data = key->data;
167 aead_xform->key.length = vec_len (key->data);
173 prepare_linked_xform (struct rte_crypto_sym_xform *xforms,
174 cryptodev_op_type_t op_type,
175 const vnet_crypto_key_t * key)
177 struct rte_crypto_sym_xform *xform_cipher, *xform_auth;
178 vnet_crypto_key_t *key_cipher, *key_auth;
179 enum rte_crypto_cipher_algorithm cipher_algo = ~0;
180 enum rte_crypto_auth_algorithm auth_algo = ~0;
183 key_cipher = vnet_crypto_get_key (key->index_crypto);
184 key_auth = vnet_crypto_get_key (key->index_integ);
185 if (!key_cipher || !key_auth)
188 if (op_type == CRYPTODEV_OP_TYPE_ENCRYPT)
190 xform_cipher = xforms;
191 xform_auth = xforms + 1;
192 xform_cipher->cipher.op = RTE_CRYPTO_CIPHER_OP_ENCRYPT;
193 xform_auth->auth.op = RTE_CRYPTO_AUTH_OP_GENERATE;
197 xform_cipher = xforms + 1;
199 xform_cipher->cipher.op = RTE_CRYPTO_CIPHER_OP_DECRYPT;
200 xform_auth->auth.op = RTE_CRYPTO_AUTH_OP_VERIFY;
203 xform_cipher->type = RTE_CRYPTO_SYM_XFORM_CIPHER;
204 xform_auth->type = RTE_CRYPTO_SYM_XFORM_AUTH;
205 xforms->next = xforms + 1;
207 switch (key->async_alg)
209 #define _(a, b, c, d) \
210 case VNET_CRYPTO_ALG_##a##_##c##_TAG##d:\
211 cipher_algo = RTE_CRYPTO_CIPHER_##b; \
212 auth_algo = RTE_CRYPTO_AUTH_##c##_HMAC; \
216 foreach_cryptodev_link_async_alg
222 xform_cipher->cipher.algo = cipher_algo;
223 xform_cipher->cipher.key.data = key_cipher->data;
224 xform_cipher->cipher.key.length = vec_len (key_cipher->data);
225 xform_cipher->cipher.iv.length = 16;
226 xform_cipher->cipher.iv.offset = CRYPTODEV_IV_OFFSET;
228 xform_auth->auth.algo = auth_algo;
229 xform_auth->auth.digest_length = digest_len;
230 xform_auth->auth.key.data = key_auth->data;
231 xform_auth->auth.key.length = vec_len (key_auth->data);
237 cryptodev_session_create (vnet_crypto_key_t * const key,
238 struct rte_mempool *sess_priv_pool,
239 cryptodev_key_t * session_pair, u32 aad_len)
241 struct rte_crypto_sym_xform xforms_enc[2] = { {0} };
242 struct rte_crypto_sym_xform xforms_dec[2] = { {0} };
243 cryptodev_main_t *cmt = &cryptodev_main;
244 cryptodev_inst_t *dev_inst;
245 struct rte_cryptodev *cdev;
249 if (key->type == VNET_CRYPTO_KEY_TYPE_LINK)
250 ret = prepare_linked_xform (xforms_enc, CRYPTODEV_OP_TYPE_ENCRYPT, key);
252 ret = prepare_aead_xform (xforms_enc, CRYPTODEV_OP_TYPE_ENCRYPT, key,
257 if (key->type == VNET_CRYPTO_KEY_TYPE_LINK)
258 prepare_linked_xform (xforms_dec, CRYPTODEV_OP_TYPE_DECRYPT, key);
260 prepare_aead_xform (xforms_dec, CRYPTODEV_OP_TYPE_DECRYPT, key, aad_len);
262 vec_foreach (dev_inst, cmt->cryptodev_inst)
264 dev_id = dev_inst->dev_id;
265 cdev = rte_cryptodev_pmd_get_dev (dev_id);
267 /* if the session is already configured for the driver type, avoid
268 configuring it again to increase the session data's refcnt */
269 if (session_pair->keys[0]->sess_data[cdev->driver_id].data &&
270 session_pair->keys[1]->sess_data[cdev->driver_id].data)
273 ret = rte_cryptodev_sym_session_init (dev_id, session_pair->keys[0],
274 xforms_enc, sess_priv_pool);
275 ret = rte_cryptodev_sym_session_init (dev_id, session_pair->keys[1],
276 xforms_dec, sess_priv_pool);
280 session_pair->keys[0]->opaque_data = aad_len;
281 session_pair->keys[1]->opaque_data = aad_len;
287 cryptodev_session_del (struct rte_cryptodev_sym_session *sess)
294 n_devs = rte_cryptodev_count ();
296 for (i = 0; i < n_devs; i++)
297 rte_cryptodev_sym_session_clear (i, sess);
299 rte_cryptodev_sym_session_free (sess);
303 cryptodev_check_supported_vnet_alg (vnet_crypto_key_t * key)
305 vnet_crypto_alg_t alg;
306 if (key->type == VNET_CRYPTO_KEY_TYPE_LINK)
311 #define _(a, b, c, d, e, f) \
312 if (alg == VNET_CRYPTO_ALG_##a) \
315 foreach_vnet_aead_crypto_conversion
320 static_always_inline void
321 cryptodev_sess_handler (vlib_main_t * vm, vnet_crypto_key_op_t kop,
322 vnet_crypto_key_index_t idx, u32 aad_len)
324 cryptodev_main_t *cmt = &cryptodev_main;
325 cryptodev_numa_data_t *numa_data;
326 vnet_crypto_key_t *key = vnet_crypto_get_key (idx);
327 struct rte_mempool *sess_pool, *sess_priv_pool;
328 cryptodev_key_t *ckey = 0;
331 if (kop == VNET_CRYPTO_KEY_OP_DEL)
333 if (idx >= vec_len (cmt->keys))
336 ckey = pool_elt_at_index (cmt->keys, idx);
337 cryptodev_session_del (ckey->keys[0]);
338 cryptodev_session_del (ckey->keys[1]);
341 pool_put (cmt->keys, ckey);
344 else if (kop == VNET_CRYPTO_KEY_OP_MODIFY)
346 if (idx >= vec_len (cmt->keys))
349 ckey = pool_elt_at_index (cmt->keys, idx);
351 cryptodev_session_del (ckey->keys[0]);
352 cryptodev_session_del (ckey->keys[1]);
356 else /* create key */
357 pool_get_zero (cmt->keys, ckey);
359 /* do not create session for unsupported alg */
360 if (cryptodev_check_supported_vnet_alg (key))
363 numa_data = vec_elt_at_index (cmt->per_numa_data, vm->numa_node);
364 sess_pool = numa_data->sess_pool;
365 sess_priv_pool = numa_data->sess_priv_pool;
367 ckey->keys[0] = rte_cryptodev_sym_session_create (sess_pool);
374 ckey->keys[1] = rte_cryptodev_sym_session_create (sess_pool);
381 ret = cryptodev_session_create (key, sess_priv_pool, ckey, aad_len);
386 cryptodev_session_del (ckey->keys[0]);
387 cryptodev_session_del (ckey->keys[1]);
388 memset (ckey, 0, sizeof (*ckey));
389 pool_put (cmt->keys, ckey);
394 cryptodev_key_handler (vlib_main_t * vm, vnet_crypto_key_op_t kop,
395 vnet_crypto_key_index_t idx)
397 cryptodev_sess_handler (vm, kop, idx, 8);
400 static_always_inline void
401 cryptodev_mark_frame_err_status (vnet_crypto_async_frame_t * f,
402 vnet_crypto_op_status_t s)
404 u32 n_elts = f->n_elts, i;
406 for (i = 0; i < n_elts; i++)
407 f->elts[i].status = s;
408 f->state = VNET_CRYPTO_FRAME_STATE_ELT_ERROR;
411 /* when vlib_buffer in chain is adjusted mbuf is not adjusted along, this
412 * function does that */
413 static_always_inline rte_iova_t
414 cryptodev_validate_mbuf_chain (vlib_main_t * vm, struct rte_mbuf *mb,
415 vlib_buffer_t * b, u8 * digest)
417 rte_iova_t digest_iova = 0;
418 struct rte_mbuf *first_mb = mb, *last_mb = mb; /**< last mbuf */
420 first_mb->nb_segs = 1;
422 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
424 b = vlib_get_buffer (vm, b->next_buffer);
425 mb = rte_mbuf_from_vlib_buffer (b);
426 if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0))
427 rte_pktmbuf_reset (mb);
430 mb->data_len = b->current_length;
431 mb->pkt_len = b->current_length;
432 mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data;
434 if (PREDICT_FALSE (b->ref_count > 1))
436 dpdk_no_cache_mempool_by_buffer_pool_index[b->buffer_pool_index];
438 if (b->data <= digest &&
439 b->data + b->current_data + b->current_length > digest)
440 digest_iova = rte_pktmbuf_iova (mb) + digest -
441 rte_pktmbuf_mtod (mb, u8 *);
447 static_always_inline int
448 cryptodev_frame_linked_algs_enqueue (vlib_main_t * vm,
449 vnet_crypto_async_frame_t * frame,
450 cryptodev_op_type_t op_type,
453 cryptodev_main_t *cmt = &cryptodev_main;
454 cryptodev_numa_data_t *numa = cmt->per_numa_data + vm->numa_node;
455 cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index;
456 vnet_crypto_async_frame_elt_t *fe;
457 cryptodev_op_t **cop;
459 u32 n_enqueue, n_elts;
460 cryptodev_key_t *key;
463 if (PREDICT_FALSE (frame == 0 || frame->n_elts == 0))
465 n_elts = frame->n_elts;
467 if (PREDICT_FALSE (CRYPTODEV_NB_CRYPTO_OPS - cet->inflight < n_elts))
469 cryptodev_mark_frame_err_status (frame,
470 VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
474 if (PREDICT_FALSE (rte_mempool_get_bulk (numa->cop_pool,
475 (void **) cet->cops, n_elts) < 0))
477 cryptodev_mark_frame_err_status (frame,
478 VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
484 bi = frame->buffer_indices;
485 cop[0]->frame = frame;
486 cop[0]->n_elts = n_elts;
488 key = pool_elt_at_index (cmt->keys, fe->key_index);
489 last_key_index = fe->key_index;
493 vlib_buffer_t *b = vlib_get_buffer (vm, bi[0]);
494 struct rte_crypto_sym_op *sop = &cop[0]->sop;
495 i16 crypto_offset = fe->crypto_start_offset;
496 i16 integ_offset = fe->integ_start_offset;
497 u32 offset_diff = crypto_offset - integ_offset;
501 CLIB_PREFETCH (cop[1], CLIB_CACHE_LINE_BYTES * 3, STORE);
502 CLIB_PREFETCH (cop[2], CLIB_CACHE_LINE_BYTES * 3, STORE);
503 CLIB_PREFETCH (&fe[1], CLIB_CACHE_LINE_BYTES, LOAD);
504 CLIB_PREFETCH (&fe[2], CLIB_CACHE_LINE_BYTES, LOAD);
506 if (last_key_index != fe->key_index)
508 key = pool_elt_at_index (cmt->keys, fe->key_index);
509 last_key_index = fe->key_index;
512 sop->m_src = rte_mbuf_from_vlib_buffer (b);
514 /* mbuf prepend happens in the tx, but vlib_buffer happens in the nodes,
515 * so we have to manually adjust mbuf data_off here so cryptodev can
516 * correctly compute the data pointer. The prepend here will be later
517 * rewritten by tx. */
518 if (PREDICT_TRUE (fe->integ_start_offset < 0))
520 rte_pktmbuf_prepend (sop->m_src, -fe->integ_start_offset);
522 crypto_offset = offset_diff;
524 sop->session = key->keys[op_type];
525 sop->cipher.data.offset = crypto_offset;
526 sop->cipher.data.length = fe->crypto_total_length;
527 sop->auth.data.offset = integ_offset;
528 sop->auth.data.length = fe->crypto_total_length + fe->integ_length_adj;
529 sop->auth.digest.data = fe->digest;
530 if (PREDICT_TRUE (!(fe->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)))
531 sop->auth.digest.phys_addr = rte_pktmbuf_iova (sop->m_src) +
532 fe->digest - rte_pktmbuf_mtod (sop->m_src, u8 *);
534 sop->auth.digest.phys_addr =
535 cryptodev_validate_mbuf_chain (vm, sop->m_src, b, fe->digest);
536 clib_memcpy_fast (cop[0]->iv, fe->iv, 16);
543 n_enqueue = rte_cryptodev_enqueue_burst (cet->cryptodev_id,
545 (struct rte_crypto_op **)
546 cet->cops, frame->n_elts);
547 ASSERT (n_enqueue == frame->n_elts);
548 cet->inflight += n_enqueue;
553 static_always_inline int
554 cryptodev_frame_gcm_enqueue (vlib_main_t * vm,
555 vnet_crypto_async_frame_t * frame,
556 cryptodev_op_type_t op_type, u8 aad_len)
558 cryptodev_main_t *cmt = &cryptodev_main;
559 cryptodev_numa_data_t *numa = cmt->per_numa_data + vm->numa_node;
560 cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index;
561 vnet_crypto_async_frame_elt_t *fe;
562 cryptodev_op_t **cop;
564 u32 n_enqueue = 0, n_elts;
565 cryptodev_key_t *key;
568 if (PREDICT_FALSE (frame == 0 || frame->n_elts == 0))
570 n_elts = frame->n_elts;
572 if (PREDICT_FALSE (CRYPTODEV_NB_CRYPTO_OPS - cet->inflight < n_elts))
574 cryptodev_mark_frame_err_status (frame,
575 VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
579 if (PREDICT_FALSE (rte_mempool_get_bulk (numa->cop_pool,
580 (void **) cet->cops, n_elts) < 0))
582 cryptodev_mark_frame_err_status (frame,
583 VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR);
589 bi = frame->buffer_indices;
590 cop[0]->frame = frame;
591 cop[0]->n_elts = n_elts;
592 frame->state = VNET_CRYPTO_OP_STATUS_COMPLETED;
594 key = pool_elt_at_index (cmt->keys, fe->key_index);
595 last_key_index = fe->key_index;
599 vlib_buffer_t *b = vlib_get_buffer (vm, bi[0]);
600 struct rte_crypto_sym_op *sop = &cop[0]->sop;
601 u16 crypto_offset = fe->crypto_start_offset;
605 CLIB_PREFETCH (cop[1], CLIB_CACHE_LINE_BYTES * 3, STORE);
606 CLIB_PREFETCH (cop[2], CLIB_CACHE_LINE_BYTES * 3, STORE);
607 CLIB_PREFETCH (&fe[1], CLIB_CACHE_LINE_BYTES, LOAD);
608 CLIB_PREFETCH (&fe[2], CLIB_CACHE_LINE_BYTES, LOAD);
610 if (last_key_index != fe->key_index)
613 key = pool_elt_at_index (cmt->keys, fe->key_index);
614 sess_aad_len = (u8) key->keys[op_type]->opaque_data;
615 if (PREDICT_FALSE (sess_aad_len != aad_len))
617 cryptodev_sess_handler (vm, VNET_CRYPTO_KEY_OP_MODIFY,
618 fe->key_index, aad_len);
620 last_key_index = fe->key_index;
623 sop->m_src = rte_mbuf_from_vlib_buffer (b);
625 /* mbuf prepend happens in the tx, but vlib_buffer happens in the nodes,
626 * so we have to manually adjust mbuf data_off here so cryptodev can
627 * correctly compute the data pointer. The prepend here will be later
628 * rewritten by tx. */
629 if (PREDICT_FALSE (fe->crypto_start_offset < 0))
631 rte_pktmbuf_prepend (sop->m_src, -fe->crypto_start_offset);
635 sop->session = key->keys[op_type];
636 sop->aead.aad.data = cop[0]->aad;
637 sop->aead.aad.phys_addr = cop[0]->op.phys_addr + CRYPTODEV_AAD_OFFSET;
638 sop->aead.data.length = fe->crypto_total_length;
639 sop->aead.data.offset = crypto_offset;
640 sop->aead.digest.data = fe->tag;
641 if (PREDICT_TRUE (!(fe->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)))
642 sop->aead.digest.phys_addr = rte_pktmbuf_iova (sop->m_src) +
643 fe->tag - rte_pktmbuf_mtod (sop->m_src, u8 *);
645 sop->aead.digest.phys_addr =
646 cryptodev_validate_mbuf_chain (vm, sop->m_src, b, fe->tag);
647 clib_memcpy_fast (cop[0]->iv, fe->iv, 12);
648 clib_memcpy_fast (cop[0]->aad, fe->aad, aad_len);
655 n_enqueue = rte_cryptodev_enqueue_burst (cet->cryptodev_id,
657 (struct rte_crypto_op **)
658 cet->cops, frame->n_elts);
659 ASSERT (n_enqueue == frame->n_elts);
660 cet->inflight += n_enqueue;
665 static_always_inline cryptodev_op_t *
666 cryptodev_get_ring_head (struct rte_ring * ring)
668 cryptodev_op_t **r = (void *) &ring[1];
669 return r[ring->cons.head & ring->mask];
672 static_always_inline vnet_crypto_async_frame_t *
673 cryptodev_frame_dequeue (vlib_main_t * vm)
675 cryptodev_main_t *cmt = &cryptodev_main;
676 cryptodev_numa_data_t *numa = cmt->per_numa_data + vm->numa_node;
677 cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index;
678 cryptodev_op_t *cop0, **cop = cet->cops;
679 vnet_crypto_async_frame_elt_t *fe;
680 vnet_crypto_async_frame_t *frame;
681 u32 n_elts, n_completed_ops = rte_ring_count (cet->ring);
682 u32 ss0 = 0, ss1 = 0, ss2 = 0, ss3 = 0; /* sum of status */
686 n_elts = clib_min (CRYPTODEV_NB_CRYPTO_OPS - n_completed_ops,
687 VNET_CRYPTO_FRAME_SIZE);
688 n_elts = rte_cryptodev_dequeue_burst
689 (cet->cryptodev_id, cet->cryptodev_q,
690 (struct rte_crypto_op **) cet->cops, n_elts);
691 cet->inflight -= n_elts;
692 n_completed_ops += n_elts;
694 rte_ring_sp_enqueue_burst (cet->ring, (void *) cet->cops, n_elts, NULL);
697 if (PREDICT_FALSE (n_completed_ops == 0))
700 cop0 = cryptodev_get_ring_head (cet->ring);
701 /* not a single frame is finished */
702 if (PREDICT_FALSE (cop0->n_elts > rte_ring_count (cet->ring)))
706 n_elts = cop0->n_elts;
707 n_elts = rte_ring_sc_dequeue_bulk (cet->ring, (void **) cet->cops,
713 ss0 |= fe[0].status = cryptodev_status_conversion[cop[0]->op.status];
714 ss1 |= fe[1].status = cryptodev_status_conversion[cop[1]->op.status];
715 ss2 |= fe[2].status = cryptodev_status_conversion[cop[2]->op.status];
716 ss3 |= fe[3].status = cryptodev_status_conversion[cop[3]->op.status];
725 ss0 |= fe[0].status = cryptodev_status_conversion[cop[0]->op.status];
731 frame->state = (ss0 | ss1 | ss2 | ss3) == VNET_CRYPTO_OP_STATUS_COMPLETED ?
732 VNET_CRYPTO_FRAME_STATE_SUCCESS : VNET_CRYPTO_FRAME_STATE_ELT_ERROR;
734 rte_mempool_put_bulk (numa->cop_pool, (void **) cet->cops, frame->n_elts);
741 #define _(a, b, c, d, e, f) \
742 static_always_inline int \
743 cryptodev_enqueue_##a##_AAD##f##_enc (vlib_main_t * vm, \
744 vnet_crypto_async_frame_t * frame) \
746 return cryptodev_frame_gcm_enqueue (vm, frame, \
747 CRYPTODEV_OP_TYPE_ENCRYPT, f); \
749 static_always_inline int \
750 cryptodev_enqueue_##a##_AAD##f##_dec (vlib_main_t * vm, \
751 vnet_crypto_async_frame_t * frame) \
753 return cryptodev_frame_gcm_enqueue (vm, frame, \
754 CRYPTODEV_OP_TYPE_DECRYPT, f); \
757 foreach_vnet_aead_crypto_conversion
760 #define _(a, b, c, d) \
761 static_always_inline int \
762 cryptodev_enqueue_##a##_##c##_TAG##d##_enc (vlib_main_t * vm, \
763 vnet_crypto_async_frame_t * frame) \
765 return cryptodev_frame_linked_algs_enqueue (vm, frame, \
766 CRYPTODEV_OP_TYPE_ENCRYPT, d); \
768 static_always_inline int \
769 cryptodev_enqueue_##a##_##c##_TAG##d##_dec (vlib_main_t * vm, \
770 vnet_crypto_async_frame_t * frame) \
772 return cryptodev_frame_linked_algs_enqueue (vm, frame, \
773 CRYPTODEV_OP_TYPE_DECRYPT, d); \
776 foreach_cryptodev_link_async_alg
781 CRYPTODEV_RESOURCE_ASSIGN_AUTO = 0,
782 CRYPTODEV_RESOURCE_ASSIGN_UPDATE,
783 } cryptodev_resource_assign_op_t;
786 * assign a cryptodev resource to a worker.
787 * @param cet: the worker thread data
788 * @param cryptodev_inst_index: if op is "ASSIGN_AUTO" this param is ignored.
789 * @param op: the assignment method.
790 * @return: 0 if successfully, negative number otherwise.
792 static_always_inline int
793 cryptodev_assign_resource (cryptodev_engine_thread_t * cet,
794 u32 cryptodev_inst_index,
795 cryptodev_resource_assign_op_t op)
797 cryptodev_main_t *cmt = &cryptodev_main;
798 cryptodev_inst_t *cinst = 0;
801 /* assign resource is only allowed when no inflight op is in the queue */
807 case CRYPTODEV_RESOURCE_ASSIGN_AUTO:
808 if (clib_bitmap_count_set_bits (cmt->active_cdev_inst_mask) >=
809 vec_len (cmt->cryptodev_inst))
812 clib_spinlock_lock (&cmt->tlock);
813 idx = clib_bitmap_first_clear (cmt->active_cdev_inst_mask);
814 clib_bitmap_set (cmt->active_cdev_inst_mask, idx, 1);
815 cinst = vec_elt_at_index (cmt->cryptodev_inst, idx);
816 cet->cryptodev_id = cinst->dev_id;
817 cet->cryptodev_q = cinst->q_id;
818 clib_spinlock_unlock (&cmt->tlock);
820 case CRYPTODEV_RESOURCE_ASSIGN_UPDATE:
821 /* assigning a used cryptodev resource is not allowed */
822 if (clib_bitmap_get (cmt->active_cdev_inst_mask, cryptodev_inst_index)
825 vec_foreach_index (idx, cmt->cryptodev_inst)
827 cinst = cmt->cryptodev_inst + idx;
828 if (cinst->dev_id == cet->cryptodev_id &&
829 cinst->q_id == cet->cryptodev_q)
832 /* invalid existing worker resource assignment */
833 if (idx == vec_len (cmt->cryptodev_inst))
835 clib_spinlock_lock (&cmt->tlock);
836 clib_bitmap_set_no_check (cmt->active_cdev_inst_mask, idx, 0);
837 clib_bitmap_set_no_check (cmt->active_cdev_inst_mask,
838 cryptodev_inst_index, 1);
839 cinst = cmt->cryptodev_inst + cryptodev_inst_index;
840 cet->cryptodev_id = cinst->dev_id;
841 cet->cryptodev_q = cinst->q_id;
842 clib_spinlock_unlock (&cmt->tlock);
851 format_cryptodev_inst (u8 * s, va_list * args)
853 cryptodev_main_t *cmt = &cryptodev_main;
854 u32 inst = va_arg (*args, u32);
855 cryptodev_inst_t *cit = cmt->cryptodev_inst + inst;
856 u32 thread_index = 0;
857 struct rte_cryptodev_info info;
859 rte_cryptodev_info_get (cit->dev_id, &info);
860 s = format (s, "%-25s%-10u", info.device->name, cit->q_id);
862 vec_foreach_index (thread_index, cmt->per_thread_data)
864 cryptodev_engine_thread_t *cet = cmt->per_thread_data + thread_index;
865 if (vlib_num_workers () > 0 && thread_index == 0)
868 if (cet->cryptodev_id == cit->dev_id && cet->cryptodev_q == cit->q_id)
870 s = format (s, "%u (%v)\n", thread_index,
871 vlib_worker_threads[thread_index].name);
876 if (thread_index == vec_len (cmt->per_thread_data))
877 s = format (s, "%s\n", "free");
882 static clib_error_t *
883 cryptodev_show_assignment_fn (vlib_main_t * vm, unformat_input_t * input,
884 vlib_cli_command_t * cmd)
886 cryptodev_main_t *cmt = &cryptodev_main;
889 vlib_cli_output (vm, "%-5s%-25s%-10s%s\n", "No.", "Name", "Queue-id",
891 if (vec_len (cmt->cryptodev_inst) == 0)
893 vlib_cli_output (vm, "(nil)\n");
897 vec_foreach_index (inst, cmt->cryptodev_inst)
898 vlib_cli_output (vm, "%-5u%U", inst, format_cryptodev_inst, inst);
903 VLIB_CLI_COMMAND (show_cryptodev_assignment, static) = {
904 .path = "show cryptodev assignment",
905 .short_help = "show cryptodev assignment",
906 .function = cryptodev_show_assignment_fn,
909 static clib_error_t *
910 cryptodev_set_assignment_fn (vlib_main_t * vm, unformat_input_t * input,
911 vlib_cli_command_t * cmd)
913 cryptodev_main_t *cmt = &cryptodev_main;
914 cryptodev_engine_thread_t *cet;
915 unformat_input_t _line_input, *line_input = &_line_input;
916 u32 thread_index, inst_index;
917 u32 thread_present = 0, inst_present = 0;
918 clib_error_t *error = 0;
921 /* Get a line of input. */
922 if (!unformat_user (input, unformat_line_input, line_input))
925 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
927 if (unformat (line_input, "thread %u", &thread_index))
929 else if (unformat (line_input, "resource %u", &inst_index))
933 error = clib_error_return (0, "unknown input `%U'",
934 format_unformat_error, line_input);
939 if (!thread_present || !inst_present)
941 error = clib_error_return (0, "mandatory argument(s) missing");
945 if (thread_index == 0 && vlib_num_workers () > 0)
948 clib_error_return (0, "assign crypto resource for master thread");
952 if (thread_index > vec_len (cmt->per_thread_data) ||
953 inst_index > vec_len (cmt->cryptodev_inst))
955 error = clib_error_return (0, "wrong thread id or resource id");
959 cet = cmt->per_thread_data + thread_index;
960 ret = cryptodev_assign_resource (cet, inst_index,
961 CRYPTODEV_RESOURCE_ASSIGN_UPDATE);
964 error = clib_error_return (0, "cryptodev_assign_resource returned %i",
972 VLIB_CLI_COMMAND (set_cryptodev_assignment, static) = {
973 .path = "set cryptodev assignment",
974 .short_help = "set cryptodev assignment thread <thread_index> "
975 "resource <inst_index>",
976 .function = cryptodev_set_assignment_fn,
980 check_cryptodev_alg_support (u32 dev_id)
982 const struct rte_cryptodev_symmetric_capability *cap;
983 struct rte_cryptodev_sym_capability_idx cap_idx;
985 #define _(a, b, c, d, e, f) \
986 cap_idx.type = RTE_CRYPTO_SYM_XFORM_##b; \
987 cap_idx.algo.aead = RTE_CRYPTO_##b##_##c; \
988 cap = rte_cryptodev_sym_capability_get (dev_id, &cap_idx); \
990 return -RTE_CRYPTO_##b##_##c; \
993 if (cap->aead.digest_size.min > e || cap->aead.digest_size.max < e) \
994 return -RTE_CRYPTO_##b##_##c; \
995 if (cap->aead.aad_size.min > f || cap->aead.aad_size.max < f) \
996 return -RTE_CRYPTO_##b##_##c; \
997 if (cap->aead.iv_size.min > d || cap->aead.iv_size.max < d) \
998 return -RTE_CRYPTO_##b##_##c; \
1001 foreach_vnet_aead_crypto_conversion
1004 #define _(a, b, c, d) \
1005 cap_idx.type = RTE_CRYPTO_SYM_XFORM_CIPHER; \
1006 cap_idx.algo.cipher = RTE_CRYPTO_CIPHER_##b; \
1007 cap = rte_cryptodev_sym_capability_get (dev_id, &cap_idx); \
1009 return -RTE_CRYPTO_CIPHER_##b; \
1010 cap_idx.type = RTE_CRYPTO_SYM_XFORM_AUTH; \
1011 cap_idx.algo.auth = RTE_CRYPTO_AUTH_##c##_HMAC; \
1012 cap = rte_cryptodev_sym_capability_get (dev_id, &cap_idx); \
1014 return -RTE_CRYPTO_AUTH_##c;
1016 foreach_cryptodev_link_async_alg
1022 cryptodev_count_queue (u32 numa)
1024 struct rte_cryptodev_info info;
1025 u32 n_cryptodev = rte_cryptodev_count ();
1028 for (i = 0; i < n_cryptodev; i++)
1030 rte_cryptodev_info_get (i, &info);
1031 if (rte_cryptodev_socket_id (i) != numa)
1033 clib_warning ("DPDK crypto resource %s is in different numa node "
1034 "as %u, ignored", info.device->name, numa);
1037 q_count += info.max_nb_queue_pairs;
1044 cryptodev_configure (vlib_main_t *vm, uint32_t cryptodev_id)
1046 struct rte_cryptodev_info info;
1047 struct rte_cryptodev *cdev;
1048 cryptodev_main_t *cmt = &cryptodev_main;
1049 cryptodev_numa_data_t *numa_data = vec_elt_at_index (cmt->per_numa_data,
1054 cdev = rte_cryptodev_pmd_get_dev (cryptodev_id);
1055 rte_cryptodev_info_get (cryptodev_id, &info);
1057 ret = check_cryptodev_alg_support (cryptodev_id);
1061 /** If the device is already started, we reuse it, otherwise configure
1062 * both the device and queue pair.
1064 if (!cdev->data->dev_started)
1066 struct rte_cryptodev_config cfg;
1068 cfg.socket_id = vm->numa_node;
1069 cfg.nb_queue_pairs = info.max_nb_queue_pairs;
1071 rte_cryptodev_configure (cryptodev_id, &cfg);
1073 for (i = 0; i < info.max_nb_queue_pairs; i++)
1075 struct rte_cryptodev_qp_conf qp_cfg;
1079 qp_cfg.mp_session = numa_data->sess_pool;
1080 qp_cfg.mp_session_private = numa_data->sess_priv_pool;
1081 qp_cfg.nb_descriptors = CRYPTODEV_NB_CRYPTO_OPS;
1083 ret = rte_cryptodev_queue_pair_setup (cryptodev_id, i, &qp_cfg,
1088 if (i != info.max_nb_queue_pairs)
1090 /* start the device */
1091 rte_cryptodev_start (i);
1094 for (i = 0; i < info.max_nb_queue_pairs; i++)
1096 cryptodev_inst_t *cdev_inst;
1097 vec_add2(cmt->cryptodev_inst, cdev_inst, 1);
1098 cdev_inst->desc = vec_new (char, strlen (info.device->name) + 10);
1099 cdev_inst->dev_id = cryptodev_id;
1100 cdev_inst->q_id = i;
1102 snprintf (cdev_inst->desc, strlen (info.device->name) + 9,
1103 "%s_q%u", info.device->name, i);
1110 cryptodev_create_device (vlib_main_t *vm, u32 n_queues)
1112 char name[RTE_CRYPTODEV_NAME_MAX_LEN], args[128];
1116 /* find an unused name to create the device */
1117 while (dev_id < RTE_CRYPTO_MAX_DEVS)
1119 snprintf (name, RTE_CRYPTODEV_NAME_MAX_LEN - 1, "%s%u",
1120 RTE_STR (CRYPTODEV_DEF_DRIVE), dev_id);
1121 if (rte_cryptodev_get_dev_id (name) < 0)
1126 if (dev_id == RTE_CRYPTO_MAX_DEVS)
1129 snprintf (args, 127, "socket_id=%u,max_nb_queue_pairs=%u",
1130 vm->numa_node, n_queues);
1132 ret = rte_vdev_init(name, args);
1136 clib_warning ("Created cryptodev device %s (%s)", name, args);
1142 cryptodev_probe (vlib_main_t *vm, u32 n_workers)
1144 u32 n_queues = cryptodev_count_queue (vm->numa_node);
1148 /* create an AESNI_MB PMD so the service is available */
1149 if (n_queues < n_workers)
1151 u32 q_num = max_pow2 (n_workers - n_queues);
1152 ret = cryptodev_create_device (vm, q_num);
1157 for (i = 0; i < rte_cryptodev_count (); i++)
1159 ret = cryptodev_configure (vm, i);
1168 cryptodev_get_session_sz (vlib_main_t *vm, uint32_t n_workers)
1170 u32 sess_data_sz = 0, i;
1173 if (rte_cryptodev_count () == 0)
1175 clib_warning ("No cryptodev device available, creating...");
1176 ret = cryptodev_create_device (vm, max_pow2 (n_workers));
1179 clib_warning ("Failed");
1184 for (i = 0; i < rte_cryptodev_count (); i++)
1186 u32 dev_sess_sz = rte_cryptodev_sym_get_private_session_size (i);
1188 sess_data_sz = dev_sess_sz > sess_data_sz ? dev_sess_sz : sess_data_sz;
1191 return sess_data_sz;
1195 dpdk_disable_cryptodev_engine (vlib_main_t * vm)
1197 cryptodev_main_t *cmt = &cryptodev_main;
1198 cryptodev_numa_data_t *numa_data;
1200 vec_validate (cmt->per_numa_data, vm->numa_node);
1201 numa_data = vec_elt_at_index (cmt->per_numa_data, vm->numa_node);
1203 if (numa_data->sess_pool)
1204 rte_mempool_free (numa_data->sess_pool);
1205 if (numa_data->sess_priv_pool)
1206 rte_mempool_free (numa_data->sess_priv_pool);
1207 if (numa_data->cop_pool)
1208 rte_mempool_free (numa_data->cop_pool);
1212 crypto_op_init (struct rte_mempool *mempool,
1213 void *_arg __attribute__ ((unused)),
1214 void *_obj, unsigned i __attribute__ ((unused)))
1216 struct rte_crypto_op *op = _obj;
1218 op->sess_type = RTE_CRYPTO_OP_WITH_SESSION;
1219 op->type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
1220 op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
1221 op->phys_addr = rte_mempool_virt2iova (_obj);
1222 op->mempool = mempool;
1227 dpdk_cryptodev_init (vlib_main_t * vm)
1229 cryptodev_main_t *cmt = &cryptodev_main;
1230 vlib_thread_main_t *tm = vlib_get_thread_main ();
1231 cryptodev_engine_thread_t *ptd;
1232 cryptodev_numa_data_t *numa_data;
1233 struct rte_mempool *mp;
1234 u32 skip_master = vlib_num_workers () > 0;
1235 u32 n_workers = tm->n_vlib_mains - skip_master;
1236 u32 numa = vm->numa_node;
1242 clib_error_t *error;
1243 struct rte_crypto_op_pool_private *priv;
1245 sess_sz = cryptodev_get_session_sz(vm, n_workers);
1248 error = clib_error_return (0, "Not enough cryptodevs");
1252 /* A total of 4 times n_worker threads * frame size as crypto ops */
1253 n_cop_elts = max_pow2 (n_workers * CRYPTODEV_NB_CRYPTO_OPS);
1255 vec_validate (cmt->per_numa_data, vm->numa_node);
1256 numa_data = vec_elt_at_index (cmt->per_numa_data, numa);
1258 /* create session pool for the numa node */
1259 name = format (0, "vcryptodev_sess_pool_%u", numa);
1260 mp = rte_cryptodev_sym_session_pool_create ((char *) name,
1261 CRYPTODEV_NB_SESSION,
1265 error = clib_error_return (0, "Not enough memory for mp %s", name);
1270 numa_data->sess_pool = mp;
1272 /* create session private pool for the numa node */
1273 name = format (0, "cryptodev_sess_pool_%u", numa);
1274 mp = rte_mempool_create ((char *) name, CRYPTODEV_NB_SESSION, sess_sz, 0,
1275 0, NULL, NULL, NULL, NULL, numa, 0);
1278 error = clib_error_return (0, "Not enough memory for mp %s", name);
1285 numa_data->sess_priv_pool = mp;
1287 /* create cryptodev op pool */
1288 name = format (0, "cryptodev_op_pool_%u", numa);
1290 mp = rte_mempool_create ((char *) name, n_cop_elts,
1291 sizeof (cryptodev_op_t), VLIB_FRAME_SIZE * 2,
1292 sizeof (struct rte_crypto_op_pool_private), NULL,
1293 NULL, crypto_op_init, NULL, numa, 0);
1296 error = clib_error_return (0, "Not enough memory for mp %s", name);
1301 priv = rte_mempool_get_priv (mp);
1302 priv->priv_size = sizeof (struct rte_crypto_op_pool_private);
1303 priv->type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
1305 numa_data->cop_pool = mp;
1307 /* probe all cryptodev devices and get queue info */
1308 if (cryptodev_probe (vm, n_workers) < 0)
1310 error = clib_error_return (0, "Failed to configure cryptodev");
1314 clib_bitmap_vec_validate (cmt->active_cdev_inst_mask, tm->n_vlib_mains);
1315 clib_spinlock_init (&cmt->tlock);
1317 vec_validate_aligned(cmt->per_thread_data, tm->n_vlib_mains - 1,
1318 CLIB_CACHE_LINE_BYTES);
1319 for (i = skip_master; i < tm->n_vlib_mains; i++)
1321 ptd = cmt->per_thread_data + i;
1322 cryptodev_assign_resource (ptd, 0, CRYPTODEV_RESOURCE_ASSIGN_AUTO);
1323 name = format (0, "frames_ring_%u", i);
1324 ptd->ring = rte_ring_create((char *) name, CRYPTODEV_NB_CRYPTO_OPS,
1325 vm->numa_node, RING_F_SP_ENQ|RING_F_SC_DEQ);
1328 error = clib_error_return (0, "Not enough memory for mp %s", name);
1332 vec_validate (ptd->cops, VNET_CRYPTO_FRAME_SIZE - 1);
1336 /* register handler */
1337 eidx = vnet_crypto_register_engine (vm, "dpdk_cryptodev", 79,
1338 "DPDK Cryptodev Engine");
1340 #define _(a, b, c, d, e, f) \
1341 vnet_crypto_register_async_handler \
1342 (vm, eidx, VNET_CRYPTO_OP_##a##_TAG##e##_AAD##f##_ENC, \
1343 cryptodev_enqueue_##a##_AAD##f##_enc, \
1344 cryptodev_frame_dequeue); \
1345 vnet_crypto_register_async_handler \
1346 (vm, eidx, VNET_CRYPTO_OP_##a##_TAG##e##_AAD##f##_DEC, \
1347 cryptodev_enqueue_##a##_AAD##f##_dec, \
1348 cryptodev_frame_dequeue);
1350 foreach_vnet_aead_crypto_conversion
1353 #define _(a, b, c, d) \
1354 vnet_crypto_register_async_handler \
1355 (vm, eidx, VNET_CRYPTO_OP_##a##_##c##_TAG##d##_ENC, \
1356 cryptodev_enqueue_##a##_##c##_TAG##d##_enc, \
1357 cryptodev_frame_dequeue); \
1358 vnet_crypto_register_async_handler \
1359 (vm, eidx, VNET_CRYPTO_OP_##a##_##c##_TAG##d##_DEC, \
1360 cryptodev_enqueue_##a##_##c##_TAG##d##_dec, \
1361 cryptodev_frame_dequeue);
1363 foreach_cryptodev_link_async_alg
1366 vnet_crypto_register_key_handler (vm, eidx, cryptodev_key_handler);
1371 dpdk_disable_cryptodev_engine (vm);
1378 * fd.io coding-style-patch-verification: ON
1381 * eval: (c-set-style "gnu")