/* *------------------------------------------------------------------ * Copyright (c) 2020 Intel and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. *------------------------------------------------------------------ */ #include #include #include #include #include #include #include #include #undef always_inline #include #include #include #include #include #include #if CLIB_DEBUG > 0 #define always_inline static inline #else #define always_inline static inline __attribute__ ((__always_inline__)) #endif #define CRYPTODEV_NB_CRYPTO_OPS 1024 #define CRYPTODEV_NB_SESSION 10240 #define CRYPTODEV_DEF_DRIVE crypto_aesni_mb #define CRYPTODEV_IV_OFFSET (offsetof (cryptodev_op_t, iv)) #define CRYPTODEV_AAD_OFFSET (offsetof (cryptodev_op_t, aad)) /* VNET_CRYPTO_ALGO, TYPE, DPDK_CRYPTO_ALGO, IV_LEN, TAG_LEN, AAD_LEN */ #define foreach_vnet_aead_crypto_conversion \ _(AES_128_GCM, AEAD, AES_GCM, 12, 16, 8) \ _(AES_128_GCM, AEAD, AES_GCM, 12, 16, 12) \ _(AES_192_GCM, AEAD, AES_GCM, 12, 16, 8) \ _(AES_192_GCM, AEAD, AES_GCM, 12, 16, 12) \ _(AES_256_GCM, AEAD, AES_GCM, 12, 16, 8) \ _(AES_256_GCM, AEAD, AES_GCM, 12, 16, 12) /** * crypto (alg, cryptodev_alg), hash (alg, digest-size) **/ #define foreach_cryptodev_link_async_alg \ _ (AES_128_CBC, AES_CBC, SHA1, 12) \ _ (AES_192_CBC, AES_CBC, SHA1, 12) \ _ (AES_256_CBC, AES_CBC, SHA1, 12) \ _ (AES_128_CBC, AES_CBC, SHA224, 14) \ _ (AES_192_CBC, AES_CBC, SHA224, 14) \ _ (AES_256_CBC, AES_CBC, SHA224, 14) \ _ (AES_128_CBC, AES_CBC, SHA256, 16) \ _ (AES_192_CBC, AES_CBC, SHA256, 16) \ _ (AES_256_CBC, AES_CBC, SHA256, 16) \ _ (AES_128_CBC, AES_CBC, SHA384, 24) \ _ (AES_192_CBC, AES_CBC, SHA384, 24) \ _ (AES_256_CBC, AES_CBC, SHA384, 24) \ _ (AES_128_CBC, AES_CBC, SHA512, 32) \ _ (AES_192_CBC, AES_CBC, SHA512, 32) \ _ (AES_256_CBC, AES_CBC, SHA512, 32) #define foreach_vnet_crypto_status_conversion \ _(SUCCESS, COMPLETED) \ _(NOT_PROCESSED, WORK_IN_PROGRESS) \ _(AUTH_FAILED, FAIL_BAD_HMAC) \ _(INVALID_SESSION, FAIL_ENGINE_ERR) \ _(INVALID_ARGS, FAIL_ENGINE_ERR) \ _(ERROR, FAIL_ENGINE_ERR) static const vnet_crypto_op_status_t cryptodev_status_conversion[] = { #define _(a, b) VNET_CRYPTO_OP_STATUS_##b, foreach_vnet_crypto_status_conversion #undef _ }; typedef struct { CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); struct rte_crypto_op op; struct rte_crypto_sym_op sop; u8 iv[16]; u8 aad[16]; vnet_crypto_async_frame_t *frame; u32 n_elts; } cryptodev_op_t; typedef enum { CRYPTODEV_OP_TYPE_ENCRYPT = 0, CRYPTODEV_OP_TYPE_DECRYPT, CRYPTODEV_N_OP_TYPES, } cryptodev_op_type_t; typedef struct { struct rte_cryptodev_sym_session *keys[CRYPTODEV_N_OP_TYPES]; } cryptodev_key_t; typedef struct { u32 dev_id; u32 q_id; char *desc; } cryptodev_inst_t; typedef struct { struct rte_mempool *cop_pool; struct rte_mempool *sess_pool; struct rte_mempool *sess_priv_pool; } cryptodev_numa_data_t; typedef struct { CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); u16 cryptodev_id; u16 cryptodev_q; u32 inflight; cryptodev_op_t **cops; struct rte_ring *ring; } cryptodev_engine_thread_t; typedef struct { cryptodev_numa_data_t *per_numa_data; cryptodev_key_t *keys; cryptodev_engine_thread_t *per_thread_data; enum rte_iova_mode iova_mode; cryptodev_inst_t *cryptodev_inst; clib_bitmap_t *active_cdev_inst_mask; clib_spinlock_t tlock; } cryptodev_main_t; cryptodev_main_t cryptodev_main; static int prepare_aead_xform (struct rte_crypto_sym_xform *xform, cryptodev_op_type_t op_type, const vnet_crypto_key_t * key, u32 aad_len) { struct rte_crypto_aead_xform *aead_xform = &xform->aead; memset (xform, 0, sizeof (*xform)); xform->type = RTE_CRYPTO_SYM_XFORM_AEAD; xform->next = 0; if (key->alg != VNET_CRYPTO_ALG_AES_128_GCM && key->alg != VNET_CRYPTO_ALG_AES_192_GCM && key->alg != VNET_CRYPTO_ALG_AES_256_GCM) return -1; aead_xform->algo = RTE_CRYPTO_AEAD_AES_GCM; aead_xform->op = (op_type == CRYPTODEV_OP_TYPE_ENCRYPT) ? RTE_CRYPTO_AEAD_OP_ENCRYPT : RTE_CRYPTO_AEAD_OP_DECRYPT; aead_xform->aad_length = aad_len; aead_xform->digest_length = 16; aead_xform->iv.offset = CRYPTODEV_IV_OFFSET; aead_xform->iv.length = 12; aead_xform->key.data = key->data; aead_xform->key.length = vec_len (key->data); return 0; } static int prepare_linked_xform (struct rte_crypto_sym_xform *xforms, cryptodev_op_type_t op_type, const vnet_crypto_key_t * key) { struct rte_crypto_sym_xform *xform_cipher, *xform_auth; vnet_crypto_key_t *key_cipher, *key_auth; enum rte_crypto_cipher_algorithm cipher_algo = ~0; enum rte_crypto_auth_algorithm auth_algo = ~0; u32 digest_len = ~0; key_cipher = vnet_crypto_get_key (key->index_crypto); key_auth = vnet_crypto_get_key (key->index_integ); if (!key_cipher || !key_auth) return -1; if (op_type == CRYPTODEV_OP_TYPE_ENCRYPT) { xform_cipher = xforms; xform_auth = xforms + 1; xform_cipher->cipher.op = RTE_CRYPTO_CIPHER_OP_ENCRYPT; xform_auth->auth.op = RTE_CRYPTO_AUTH_OP_GENERATE; } else { xform_cipher = xforms + 1; xform_auth = xforms; xform_cipher->cipher.op = RTE_CRYPTO_CIPHER_OP_DECRYPT; xform_auth->auth.op = RTE_CRYPTO_AUTH_OP_VERIFY; } xform_cipher->type = RTE_CRYPTO_SYM_XFORM_CIPHER; xform_auth->type = RTE_CRYPTO_SYM_XFORM_AUTH; xforms->next = xforms + 1; switch (key->async_alg) { #define _(a, b, c, d) \ case VNET_CRYPTO_ALG_##a##_##c##_TAG##d:\ cipher_algo = RTE_CRYPTO_CIPHER_##b; \ auth_algo = RTE_CRYPTO_AUTH_##c##_HMAC; \ digest_len = d; \ break; foreach_cryptodev_link_async_alg #undef _ default: return -1; } xform_cipher->cipher.algo = cipher_algo; xform_cipher->cipher.key.data = key_cipher->data; xform_cipher->cipher.key.length = vec_len (key_cipher->data); xform_cipher->cipher.iv.length = 16; xform_cipher->cipher.iv.offset = CRYPTODEV_IV_OFFSET; xform_auth->auth.algo = auth_algo; xform_auth->auth.digest_length = digest_len; xform_auth->auth.key.data = key_auth->data; xform_auth->auth.key.length = vec_len (key_auth->data); return 0; } static int cryptodev_session_create (vnet_crypto_key_t * const key, struct rte_mempool *sess_priv_pool, cryptodev_key_t * session_pair, u32 aad_len) { struct rte_crypto_sym_xform xforms_enc[2] = { {0} }; struct rte_crypto_sym_xform xforms_dec[2] = { {0} }; cryptodev_main_t *cmt = &cryptodev_main; cryptodev_inst_t *dev_inst; struct rte_cryptodev *cdev; int ret; uint8_t dev_id = 0; if (key->type == VNET_CRYPTO_KEY_TYPE_LINK) ret = prepare_linked_xform (xforms_enc, CRYPTODEV_OP_TYPE_ENCRYPT, key); else ret = prepare_aead_xform (xforms_enc, CRYPTODEV_OP_TYPE_ENCRYPT, key, aad_len); if (ret) return 0; if (key->type == VNET_CRYPTO_KEY_TYPE_LINK) prepare_linked_xform (xforms_dec, CRYPTODEV_OP_TYPE_DECRYPT, key); else prepare_aead_xform (xforms_dec, CRYPTODEV_OP_TYPE_DECRYPT, key, aad_len); vec_foreach (dev_inst, cmt->cryptodev_inst) { dev_id = dev_inst->dev_id; cdev = rte_cryptodev_pmd_get_dev (dev_id); /* if the session is already configured for the driver type, avoid configuring it again to increase the session data's refcnt */ if (session_pair->keys[0]->sess_data[cdev->driver_id].data && session_pair->keys[1]->sess_data[cdev->driver_id].data) continue; ret = rte_cryptodev_sym_session_init (dev_id, session_pair->keys[0], xforms_enc, sess_priv_pool); ret = rte_cryptodev_sym_session_init (dev_id, session_pair->keys[1], xforms_dec, sess_priv_pool); if (ret < 0) return ret; } session_pair->keys[0]->opaque_data = aad_len; session_pair->keys[1]->opaque_data = aad_len; return 0; } static void cryptodev_session_del (struct rte_cryptodev_sym_session *sess) { u32 n_devs, i; if (sess == NULL) return; n_devs = rte_cryptodev_count (); for (i = 0; i < n_devs; i++) rte_cryptodev_sym_session_clear (i, sess); rte_cryptodev_sym_session_free (sess); } static int cryptodev_check_supported_vnet_alg (vnet_crypto_key_t * key) { vnet_crypto_alg_t alg; if (key->type == VNET_CRYPTO_KEY_TYPE_LINK) return 0; alg = key->alg; #define _(a, b, c, d, e, f) \ if (alg == VNET_CRYPTO_ALG_##a) \ return 0; foreach_vnet_aead_crypto_conversion #undef _ return -1; } static_always_inline void cryptodev_sess_handler (vlib_main_t * vm, vnet_crypto_key_op_t kop, vnet_crypto_key_index_t idx, u32 aad_len) { cryptodev_main_t *cmt = &cryptodev_main; cryptodev_numa_data_t *numa_data; vnet_crypto_key_t *key = vnet_crypto_get_key (idx); struct rte_mempool *sess_pool, *sess_priv_pool; cryptodev_key_t *ckey = 0; int ret = 0; if (kop == VNET_CRYPTO_KEY_OP_DEL) { if (idx >= vec_len (cmt->keys)) return; ckey = pool_elt_at_index (cmt->keys, idx); cryptodev_session_del (ckey->keys[0]); cryptodev_session_del (ckey->keys[1]); ckey->keys[0] = 0; ckey->keys[1] = 0; pool_put (cmt->keys, ckey); return; } else if (kop == VNET_CRYPTO_KEY_OP_MODIFY) { if (idx >= vec_len (cmt->keys)) return; ckey = pool_elt_at_index (cmt->keys, idx); cryptodev_session_del (ckey->keys[0]); cryptodev_session_del (ckey->keys[1]); ckey->keys[0] = 0; ckey->keys[1] = 0; } else /* create key */ pool_get_zero (cmt->keys, ckey); /* do not create session for unsupported alg */ if (cryptodev_check_supported_vnet_alg (key)) return; numa_data = vec_elt_at_index (cmt->per_numa_data, vm->numa_node); sess_pool = numa_data->sess_pool; sess_priv_pool = numa_data->sess_priv_pool; ckey->keys[0] = rte_cryptodev_sym_session_create (sess_pool); if (!ckey->keys[0]) { ret = -1; goto clear_key; } ckey->keys[1] = rte_cryptodev_sym_session_create (sess_pool); if (!ckey->keys[1]) { ret = -1; goto clear_key; } ret = cryptodev_session_create (key, sess_priv_pool, ckey, aad_len); clear_key: if (ret != 0) { cryptodev_session_del (ckey->keys[0]); cryptodev_session_del (ckey->keys[1]); memset (ckey, 0, sizeof (*ckey)); pool_put (cmt->keys, ckey); } } /*static*/ void cryptodev_key_handler (vlib_main_t * vm, vnet_crypto_key_op_t kop, vnet_crypto_key_index_t idx) { cryptodev_sess_handler (vm, kop, idx, 8); } static_always_inline void cryptodev_mark_frame_err_status (vnet_crypto_async_frame_t * f, vnet_crypto_op_status_t s) { u32 n_elts = f->n_elts, i; for (i = 0; i < n_elts; i++) f->elts[i].status = s; f->state = VNET_CRYPTO_FRAME_STATE_ELT_ERROR; } static_always_inline rte_iova_t cryptodev_get_iova (clib_pmalloc_main_t * pm, enum rte_iova_mode mode, void *data) { u64 index; if (mode == RTE_IOVA_VA) return (rte_iova_t) pointer_to_uword (data); index = clib_pmalloc_get_page_index (pm, data); return pointer_to_uword (data) - pm->lookup_table[index]; } static_always_inline void cryptodev_validate_mbuf_chain (vlib_main_t * vm, struct rte_mbuf *mb, vlib_buffer_t * b) { struct rte_mbuf *first_mb = mb, *last_mb = mb; /**< last mbuf */ /* when input node is not dpdk, mbuf data len is not initialized, for * single buffer it is not a problem since the data length is written * into cryptodev operation. For chained buffer a reference data length * has to be computed through vlib_buffer. * * even when input node is dpdk, it is possible chained vlib_buffers * are updated (either added or removed a buffer) but not not mbuf fields. * we have to re-link every mbuf in the chain. */ u16 data_len = b->current_length + (b->data + b->current_data - rte_pktmbuf_mtod (mb, u8 *)); first_mb->nb_segs = 1; first_mb->pkt_len = first_mb->data_len = data_len; while (b->flags & VLIB_BUFFER_NEXT_PRESENT) { b = vlib_get_buffer (vm, b->next_buffer); mb = rte_mbuf_from_vlib_buffer (b); if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_EXT_HDR_VALID) == 0)) rte_pktmbuf_reset (mb); last_mb->next = mb; last_mb = mb; mb->data_len = b->current_length; mb->pkt_len = b->current_length; mb->data_off = VLIB_BUFFER_PRE_DATA_SIZE + b->current_data; first_mb->nb_segs++; if (PREDICT_FALSE (b->ref_count > 1)) mb->pool = dpdk_no_cache_mempool_by_buffer_pool_index[b->buffer_pool_index]; } } static_always_inline int cryptodev_frame_linked_algs_enqueue (vlib_main_t * vm, vnet_crypto_async_frame_t * frame, cryptodev_op_type_t op_type) { cryptodev_main_t *cmt = &cryptodev_main; clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main; cryptodev_numa_data_t *numa = cmt->per_numa_data + vm->numa_node; cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index; vnet_crypto_async_frame_elt_t *fe; cryptodev_op_t **cop; u32 *bi; u32 n_enqueue, n_elts; cryptodev_key_t *key; u32 last_key_index; if (PREDICT_FALSE (frame == 0 || frame->n_elts == 0)) return -1; n_elts = frame->n_elts; if (PREDICT_FALSE (CRYPTODEV_NB_CRYPTO_OPS - cet->inflight < n_elts)) { cryptodev_mark_frame_err_status (frame, VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR); return -1; } if (PREDICT_FALSE (rte_mempool_get_bulk (numa->cop_pool, (void **) cet->cops, n_elts) < 0)) { cryptodev_mark_frame_err_status (frame, VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR); return -1; } cop = cet->cops; fe = frame->elts; bi = frame->buffer_indices; cop[0]->frame = frame; cop[0]->n_elts = n_elts; key = pool_elt_at_index (cmt->keys, fe->key_index); last_key_index = fe->key_index; while (n_elts) { vlib_buffer_t *b = vlib_get_buffer (vm, bi[0]); struct rte_crypto_sym_op *sop = &cop[0]->sop; i16 crypto_offset = fe->crypto_start_offset; i16 integ_offset = fe->integ_start_offset; u32 offset_diff = crypto_offset - integ_offset; if (n_elts > 2) { CLIB_PREFETCH (cop[1], CLIB_CACHE_LINE_BYTES * 3, STORE); CLIB_PREFETCH (cop[2], CLIB_CACHE_LINE_BYTES * 3, STORE); CLIB_PREFETCH (&fe[1], CLIB_CACHE_LINE_BYTES, LOAD); CLIB_PREFETCH (&fe[2], CLIB_CACHE_LINE_BYTES, LOAD); } if (last_key_index != fe->key_index) { key = pool_elt_at_index (cmt->keys, fe->key_index); last_key_index = fe->key_index; } sop->m_src = rte_mbuf_from_vlib_buffer (b); sop->m_src->data_off = VLIB_BUFFER_PRE_DATA_SIZE; sop->m_dst = 0; /* mbuf prepend happens in the tx, but vlib_buffer happens in the nodes, * so we have to manually adjust mbuf data_off here so cryptodev can * correctly compute the data pointer. The prepend here will be later * rewritten by tx. */ if (PREDICT_TRUE (fe->integ_start_offset < 0)) { sop->m_src->data_off += fe->integ_start_offset; integ_offset = 0; crypto_offset = offset_diff; } sop->session = key->keys[op_type]; sop->cipher.data.offset = crypto_offset; sop->cipher.data.length = fe->crypto_total_length; sop->auth.data.offset = integ_offset; sop->auth.data.length = fe->crypto_total_length + fe->integ_length_adj; sop->auth.digest.data = fe->digest; sop->auth.digest.phys_addr = cryptodev_get_iova (pm, cmt->iova_mode, fe->digest); if (PREDICT_FALSE (fe->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)) cryptodev_validate_mbuf_chain (vm, sop->m_src, b); else /* for input nodes that are not dpdk-input, it is possible the mbuf * was updated before as one of the chained mbufs. Setting nb_segs * to 1 here to prevent the cryptodev PMD to access potentially * invalid m_src->next pointers. */ sop->m_src->nb_segs = 1; clib_memcpy_fast (cop[0]->iv, fe->iv, 16); cop++; bi++; fe++; n_elts--; } n_enqueue = rte_cryptodev_enqueue_burst (cet->cryptodev_id, cet->cryptodev_q, (struct rte_crypto_op **) cet->cops, frame->n_elts); ASSERT (n_enqueue == frame->n_elts); cet->inflight += n_enqueue; return 0; } static_always_inline int cryptodev_frame_gcm_enqueue (vlib_main_t * vm, vnet_crypto_async_frame_t * frame, cryptodev_op_type_t op_type, u8 aad_len) { cryptodev_main_t *cmt = &cryptodev_main; clib_pmalloc_main_t *pm = vm->physmem_main.pmalloc_main; cryptodev_numa_data_t *numa = cmt->per_numa_data + vm->numa_node; cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index; vnet_crypto_async_frame_elt_t *fe; cryptodev_op_t **cop; u32 *bi; u32 n_enqueue = 0, n_elts; cryptodev_key_t *key; u32 last_key_index; u8 sess_aad_len; if (PREDICT_FALSE (frame == 0 || frame->n_elts == 0)) return -1; n_elts = frame->n_elts; if (PREDICT_FALSE (CRYPTODEV_NB_CRYPTO_OPS - cet->inflight < n_elts)) { cryptodev_mark_frame_err_status (frame, VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR); return -1; } if (PREDICT_FALSE (rte_mempool_get_bulk (numa->cop_pool, (void **) cet->cops, n_elts) < 0)) { cryptodev_mark_frame_err_status (frame, VNET_CRYPTO_OP_STATUS_FAIL_ENGINE_ERR); return -1; } cop = cet->cops; fe = frame->elts; bi = frame->buffer_indices; cop[0]->frame = frame; cop[0]->n_elts = n_elts; key = pool_elt_at_index (cmt->keys, fe->key_index); last_key_index = fe->key_index; sess_aad_len = (u8) key->keys[op_type]->opaque_data; if (PREDICT_FALSE (sess_aad_len != aad_len)) cryptodev_sess_handler (vm, VNET_CRYPTO_KEY_OP_MODIFY, fe->key_index, aad_len); while (n_elts) { vlib_buffer_t *b = vlib_get_buffer (vm, bi[0]); struct rte_crypto_sym_op *sop = &cop[0]->sop; u16 crypto_offset = fe->crypto_start_offset; if (n_elts > 2) { CLIB_PREFETCH (cop[1], CLIB_CACHE_LINE_BYTES * 3, STORE); CLIB_PREFETCH (cop[2], CLIB_CACHE_LINE_BYTES * 3, STORE); CLIB_PREFETCH (&fe[1], CLIB_CACHE_LINE_BYTES, LOAD); CLIB_PREFETCH (&fe[2], CLIB_CACHE_LINE_BYTES, LOAD); } if (last_key_index != fe->key_index) { key = pool_elt_at_index (cmt->keys, fe->key_index); sess_aad_len = (u8) key->keys[op_type]->opaque_data; if (PREDICT_FALSE (sess_aad_len != aad_len)) { cryptodev_sess_handler (vm, VNET_CRYPTO_KEY_OP_MODIFY, fe->key_index, aad_len); } last_key_index = fe->key_index; } sop->m_src = rte_mbuf_from_vlib_buffer (b); sop->m_dst = 0; /* mbuf prepend happens in the tx, but vlib_buffer happens in the nodes, * so we have to manually adjust mbuf data_off here so cryptodev can * correctly compute the data pointer. The prepend here will be later * rewritten by tx. */ if (PREDICT_FALSE (fe->crypto_start_offset < 0)) { rte_pktmbuf_prepend (sop->m_src, -fe->crypto_start_offset); crypto_offset = 0; } sop->session = key->keys[op_type]; sop->aead.aad.data = cop[0]->aad; sop->aead.aad.phys_addr = cop[0]->op.phys_addr + CRYPTODEV_AAD_OFFSET; sop->aead.data.length = fe->crypto_total_length; sop->aead.data.offset = crypto_offset; sop->aead.digest.data = fe->tag; sop->aead.digest.phys_addr = cryptodev_get_iova (pm, cmt->iova_mode, fe->tag); if (PREDICT_FALSE (fe->flags & VNET_CRYPTO_OP_FLAG_CHAINED_BUFFERS)) cryptodev_validate_mbuf_chain (vm, sop->m_src, b); else /* for input nodes that are not dpdk-input, it is possible the mbuf * was updated before as one of the chained mbufs. Setting nb_segs * to 1 here to prevent the cryptodev PMD to access potentially * invalid m_src->next pointers. */ sop->m_src->nb_segs = 1; clib_memcpy_fast (cop[0]->iv, fe->iv, 12); clib_memcpy_fast (cop[0]->aad, fe->aad, aad_len); cop++; bi++; fe++; n_elts--; } n_enqueue = rte_cryptodev_enqueue_burst (cet->cryptodev_id, cet->cryptodev_q, (struct rte_crypto_op **) cet->cops, frame->n_elts); ASSERT (n_enqueue == frame->n_elts); cet->inflight += n_enqueue; return 0; } static_always_inline cryptodev_op_t * cryptodev_get_ring_head (struct rte_ring * ring) { cryptodev_op_t **r = (void *) &ring[1]; return r[ring->cons.head & ring->mask]; } static_always_inline vnet_crypto_async_frame_t * cryptodev_frame_dequeue (vlib_main_t * vm, u32 * nb_elts_processed, u32 * enqueue_thread_idx) { cryptodev_main_t *cmt = &cryptodev_main; cryptodev_numa_data_t *numa = cmt->per_numa_data + vm->numa_node; cryptodev_engine_thread_t *cet = cmt->per_thread_data + vm->thread_index; cryptodev_op_t *cop0, **cop = cet->cops; vnet_crypto_async_frame_elt_t *fe; vnet_crypto_async_frame_t *frame; u32 n_elts, n_completed_ops = rte_ring_count (cet->ring); u32 ss0 = 0, ss1 = 0, ss2 = 0, ss3 = 0; /* sum of status */ if (cet->inflight) { n_elts = clib_min (CRYPTODEV_NB_CRYPTO_OPS - n_completed_ops, VNET_CRYPTO_FRAME_SIZE); n_elts = rte_cryptodev_dequeue_burst (cet->cryptodev_id, cet->cryptodev_q, (struct rte_crypto_op **) cet->cops, n_elts); cet->inflight -= n_elts; n_completed_ops += n_elts; rte_ring_sp_enqueue_burst (cet->ring, (void *) cet->cops, n_elts, NULL); } if (PREDICT_FALSE (n_completed_ops == 0)) return 0; cop0 = cryptodev_get_ring_head (cet->ring); /* not a single frame is finished */ if (PREDICT_FALSE (cop0->n_elts > rte_ring_count (cet->ring))) return 0; frame = cop0->frame; n_elts = cop0->n_elts; n_elts = rte_ring_sc_dequeue_bulk (cet->ring, (void **) cet->cops, n_elts, 0); fe = frame->elts; while (n_elts > 4) { ss0 |= fe[0].status = cryptodev_status_conversion[cop[0]->op.status]; ss1 |= fe[1].status = cryptodev_status_conversion[cop[1]->op.status]; ss2 |= fe[2].status = cryptodev_status_conversion[cop[2]->op.status]; ss3 |= fe[3].status = cryptodev_status_conversion[cop[3]->op.status]; cop += 4; fe += 4; n_elts -= 4; } while (n_elts) { ss0 |= fe[0].status = cryptodev_status_conversion[cop[0]->op.status]; fe++; cop++; n_elts--; } frame->state = (ss0 | ss1 | ss2 | ss3) == VNET_CRYPTO_OP_STATUS_COMPLETED ? VNET_CRYPTO_FRAME_STATE_SUCCESS : VNET_CRYPTO_FRAME_STATE_ELT_ERROR; rte_mempool_put_bulk (numa->cop_pool, (void **) cet->cops, frame->n_elts); *nb_elts_processed = frame->n_elts; *enqueue_thread_idx = frame->enqueue_thread_index; return frame; } /* *INDENT-OFF* */ static_always_inline int cryptodev_enqueue_gcm_aad_8_enc (vlib_main_t * vm, vnet_crypto_async_frame_t * frame) { return cryptodev_frame_gcm_enqueue (vm, frame, CRYPTODEV_OP_TYPE_ENCRYPT, 8); } static_always_inline int cryptodev_enqueue_gcm_aad_12_enc (vlib_main_t * vm, vnet_crypto_async_frame_t * frame) { return cryptodev_frame_gcm_enqueue (vm, frame, CRYPTODEV_OP_TYPE_ENCRYPT, 12); } static_always_inline int cryptodev_enqueue_gcm_aad_8_dec (vlib_main_t * vm, vnet_crypto_async_frame_t * frame) { return cryptodev_frame_gcm_enqueue (vm, frame, CRYPTODEV_OP_TYPE_DECRYPT, 8); } static_always_inline int cryptodev_enqueue_gcm_aad_12_dec (vlib_main_t * vm, vnet_crypto_async_frame_t * frame) { return cryptodev_frame_gcm_enqueue (vm, frame, CRYPTODEV_OP_TYPE_DECRYPT, 12); } static_always_inline int cryptodev_enqueue_linked_alg_enc (vlib_main_t * vm, vnet_crypto_async_frame_t * frame) { return cryptodev_frame_linked_algs_enqueue (vm, frame, CRYPTODEV_OP_TYPE_ENCRYPT); } static_always_inline int cryptodev_enqueue_linked_alg_dec (vlib_main_t * vm, vnet_crypto_async_frame_t * frame) { return cryptodev_frame_linked_algs_enqueue (vm, frame, CRYPTODEV_OP_TYPE_DECRYPT); } typedef enum { CRYPTODEV_RESOURCE_ASSIGN_AUTO = 0, CRYPTODEV_RESOURCE_ASSIGN_UPDATE, } cryptodev_resource_assign_op_t; /** * assign a cryptodev resource to a worker. * @param cet: the worker thread data * @param cryptodev_inst_index: if op is "ASSIGN_AUTO" this param is ignored. * @param op: the assignment method. * @return: 0 if successfully, negative number otherwise. **/ static_always_inline int cryptodev_assign_resource (cryptodev_engine_thread_t * cet, u32 cryptodev_inst_index, cryptodev_resource_assign_op_t op) { cryptodev_main_t *cmt = &cryptodev_main; cryptodev_inst_t *cinst = 0; uword idx; /* assign resource is only allowed when no inflight op is in the queue */ if (cet->inflight) return -EBUSY; switch (op) { case CRYPTODEV_RESOURCE_ASSIGN_AUTO: if (clib_bitmap_count_set_bits (cmt->active_cdev_inst_mask) >= vec_len (cmt->cryptodev_inst)) return -1; clib_spinlock_lock (&cmt->tlock); idx = clib_bitmap_first_clear (cmt->active_cdev_inst_mask); clib_bitmap_set (cmt->active_cdev_inst_mask, idx, 1); cinst = vec_elt_at_index (cmt->cryptodev_inst, idx); cet->cryptodev_id = cinst->dev_id; cet->cryptodev_q = cinst->q_id; clib_spinlock_unlock (&cmt->tlock); break; case CRYPTODEV_RESOURCE_ASSIGN_UPDATE: /* assigning a used cryptodev resource is not allowed */ if (clib_bitmap_get (cmt->active_cdev_inst_mask, cryptodev_inst_index) == 1) return -EBUSY; vec_foreach_index (idx, cmt->cryptodev_inst) { cinst = cmt->cryptodev_inst + idx; if (cinst->dev_id == cet->cryptodev_id && cinst->q_id == cet->cryptodev_q) break; } /* invalid existing worker resource assignment */ if (idx == vec_len (cmt->cryptodev_inst)) return -EINVAL; clib_spinlock_lock (&cmt->tlock); clib_bitmap_set_no_check (cmt->active_cdev_inst_mask, idx, 0); clib_bitmap_set_no_check (cmt->active_cdev_inst_mask, cryptodev_inst_index, 1); cinst = cmt->cryptodev_inst + cryptodev_inst_index; cet->cryptodev_id = cinst->dev_id; cet->cryptodev_q = cinst->q_id; clib_spinlock_unlock (&cmt->tlock); break; default: return -EINVAL; } return 0; } static u8 * format_cryptodev_inst (u8 * s, va_list * args) { cryptodev_main_t *cmt = &cryptodev_main; u32 inst = va_arg (*args, u32); cryptodev_inst_t *cit = cmt->cryptodev_inst + inst; u32 thread_index = 0; struct rte_cryptodev_info info; rte_cryptodev_info_get (cit->dev_id, &info); s = format (s, "%-25s%-10u", info.device->name, cit->q_id); vec_foreach_index (thread_index, cmt->per_thread_data) { cryptodev_engine_thread_t *cet = cmt->per_thread_data + thread_index; if (vlib_num_workers () > 0 && thread_index == 0) continue; if (cet->cryptodev_id == cit->dev_id && cet->cryptodev_q == cit->q_id) { s = format (s, "%u (%v)\n", thread_index, vlib_worker_threads[thread_index].name); break; } } if (thread_index == vec_len (cmt->per_thread_data)) s = format (s, "%s\n", "free"); return s; } static clib_error_t * cryptodev_show_assignment_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { cryptodev_main_t *cmt = &cryptodev_main; u32 inst; vlib_cli_output (vm, "%-5s%-25s%-10s%s\n", "No.", "Name", "Queue-id", "Assigned-to"); if (vec_len (cmt->cryptodev_inst) == 0) { vlib_cli_output (vm, "(nil)\n"); return 0; } vec_foreach_index (inst, cmt->cryptodev_inst) vlib_cli_output (vm, "%-5u%U", inst, format_cryptodev_inst, inst); return 0; } VLIB_CLI_COMMAND (show_cryptodev_assignment, static) = { .path = "show cryptodev assignment", .short_help = "show cryptodev assignment", .function = cryptodev_show_assignment_fn, }; static clib_error_t * cryptodev_set_assignment_fn (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd) { cryptodev_main_t *cmt = &cryptodev_main; cryptodev_engine_thread_t *cet; unformat_input_t _line_input, *line_input = &_line_input; u32 thread_index, inst_index; u32 thread_present = 0, inst_present = 0; clib_error_t *error = 0; int ret; /* Get a line of input. */ if (!unformat_user (input, unformat_line_input, line_input)) return 0; while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) { if (unformat (line_input, "thread %u", &thread_index)) thread_present = 1; else if (unformat (line_input, "resource %u", &inst_index)) inst_present = 1; else { error = clib_error_return (0, "unknown input `%U'", format_unformat_error, line_input); return error; } } if (!thread_present || !inst_present) { error = clib_error_return (0, "mandatory argument(s) missing"); return error; } if (thread_index == 0 && vlib_num_workers () > 0) { error = clib_error_return (0, "assign crypto resource for master thread"); return error; } if (thread_index > vec_len (cmt->per_thread_data) || inst_index > vec_len (cmt->cryptodev_inst)) { error = clib_error_return (0, "wrong thread id or resource id"); return error; } cet = cmt->per_thread_data + thread_index; ret = cryptodev_assign_resource (cet, inst_index, CRYPTODEV_RESOURCE_ASSIGN_UPDATE); if (ret) { error = clib_error_return (0, "cryptodev_assign_resource returned %i", ret); return error; } return 0; } VLIB_CLI_COMMAND (set_cryptodev_assignment, static) = { .path = "set cryptodev assignment", .short_help = "set cryptodev assignment thread " "resource ", .function = cryptodev_set_assignment_fn, }; static int check_cryptodev_alg_support (u32 dev_id) { const struct rte_cryptodev_symmetric_capability *cap; struct rte_cryptodev_sym_capability_idx cap_idx; #define _(a, b, c, d, e, f) \ cap_idx.type = RTE_CRYPTO_SYM_XFORM_##b; \ cap_idx.algo.aead = RTE_CRYPTO_##b##_##c; \ cap = rte_cryptodev_sym_capability_get (dev_id, &cap_idx); \ if (!cap) \ return -RTE_CRYPTO_##b##_##c; \ else \ { \ if (cap->aead.digest_size.min > e || cap->aead.digest_size.max < e) \ return -RTE_CRYPTO_##b##_##c; \ if (cap->aead.aad_size.min > f || cap->aead.aad_size.max < f) \ return -RTE_CRYPTO_##b##_##c; \ if (cap->aead.iv_size.min > d || cap->aead.iv_size.max < d) \ return -RTE_CRYPTO_##b##_##c; \ } foreach_vnet_aead_crypto_conversion #undef _ #define _(a, b, c, d) \ cap_idx.type = RTE_CRYPTO_SYM_XFORM_CIPHER; \ cap_idx.algo.cipher = RTE_CRYPTO_CIPHER_##b; \ cap = rte_cryptodev_sym_capability_get (dev_id, &cap_idx); \ if (!cap) \ return -RTE_CRYPTO_CIPHER_##b; \ cap_idx.type = RTE_CRYPTO_SYM_XFORM_AUTH; \ cap_idx.algo.auth = RTE_CRYPTO_AUTH_##c##_HMAC; \ cap = rte_cryptodev_sym_capability_get (dev_id, &cap_idx); \ if (!cap) \ return -RTE_CRYPTO_AUTH_##c; foreach_cryptodev_link_async_alg #undef _ return 0; } static u32 cryptodev_count_queue (u32 numa) { struct rte_cryptodev_info info; u32 n_cryptodev = rte_cryptodev_count (); u32 i, q_count = 0; for (i = 0; i < n_cryptodev; i++) { rte_cryptodev_info_get (i, &info); if (rte_cryptodev_socket_id (i) != numa) { clib_warning ("DPDK crypto resource %s is in different numa node " "as %u, ignored", info.device->name, numa); continue; } q_count += info.max_nb_queue_pairs; } return q_count; } static int cryptodev_configure (vlib_main_t *vm, uint32_t cryptodev_id) { struct rte_cryptodev_info info; struct rte_cryptodev *cdev; cryptodev_main_t *cmt = &cryptodev_main; cryptodev_numa_data_t *numa_data = vec_elt_at_index (cmt->per_numa_data, vm->numa_node); u32 i; int ret; cdev = rte_cryptodev_pmd_get_dev (cryptodev_id); rte_cryptodev_info_get (cryptodev_id, &info); ret = check_cryptodev_alg_support (cryptodev_id); if (ret != 0) return ret; /** If the device is already started, we reuse it, otherwise configure * both the device and queue pair. **/ if (!cdev->data->dev_started) { struct rte_cryptodev_config cfg; cfg.socket_id = vm->numa_node; cfg.nb_queue_pairs = info.max_nb_queue_pairs; rte_cryptodev_configure (cryptodev_id, &cfg); for (i = 0; i < info.max_nb_queue_pairs; i++) { struct rte_cryptodev_qp_conf qp_cfg; int ret; qp_cfg.mp_session = numa_data->sess_pool; qp_cfg.mp_session_private = numa_data->sess_priv_pool; qp_cfg.nb_descriptors = CRYPTODEV_NB_CRYPTO_OPS; ret = rte_cryptodev_queue_pair_setup (cryptodev_id, i, &qp_cfg, vm->numa_node); if (ret) break; } if (i != info.max_nb_queue_pairs) return -1; /* start the device */ rte_cryptodev_start (i); } for (i = 0; i < info.max_nb_queue_pairs; i++) { cryptodev_inst_t *cdev_inst; vec_add2(cmt->cryptodev_inst, cdev_inst, 1); cdev_inst->desc = vec_new (char, strlen (info.device->name) + 10); cdev_inst->dev_id = cryptodev_id; cdev_inst->q_id = i; snprintf (cdev_inst->desc, strlen (info.device->name) + 9, "%s_q%u", info.device->name, i); } return 0; } static int cryptodev_create_device (vlib_main_t *vm, u32 n_queues) { char name[RTE_CRYPTODEV_NAME_MAX_LEN], args[128]; u32 dev_id = 0; int ret; /* find an unused name to create the device */ while (dev_id < RTE_CRYPTO_MAX_DEVS) { snprintf (name, RTE_CRYPTODEV_NAME_MAX_LEN - 1, "%s%u", RTE_STR (CRYPTODEV_DEF_DRIVE), dev_id); if (rte_cryptodev_get_dev_id (name) < 0) break; dev_id++; } if (dev_id == RTE_CRYPTO_MAX_DEVS) return -1; snprintf (args, 127, "socket_id=%u,max_nb_queue_pairs=%u", vm->numa_node, n_queues); ret = rte_vdev_init(name, args); if (ret < 0) return ret; clib_warning ("Created cryptodev device %s (%s)", name, args); return 0; } static int cryptodev_cmp (void *v1, void *v2) { cryptodev_inst_t *a1 = v1; cryptodev_inst_t *a2 = v2; if (a1->q_id > a2->q_id) return 1; if (a1->q_id < a2->q_id) return -1; return 0; } static int cryptodev_probe (vlib_main_t *vm, u32 n_workers) { cryptodev_main_t *cmt = &cryptodev_main; u32 n_queues = cryptodev_count_queue (vm->numa_node); u32 i; int ret; /* create an AESNI_MB PMD so the service is available */ if (n_queues < n_workers) { u32 q_num = max_pow2 (n_workers - n_queues); ret = cryptodev_create_device (vm, q_num); if (ret < 0) return ret; } for (i = 0; i < rte_cryptodev_count (); i++) { ret = cryptodev_configure (vm, i); if (ret) return ret; } vec_sort_with_function(cmt->cryptodev_inst, cryptodev_cmp); return 0; } static int cryptodev_get_session_sz (vlib_main_t *vm, uint32_t n_workers) { u32 sess_data_sz = 0, i; int ret; if (rte_cryptodev_count () == 0) { clib_warning ("No cryptodev device available, creating..."); ret = cryptodev_create_device (vm, max_pow2 (n_workers)); if (ret < 0) { clib_warning ("Failed"); return ret; } } for (i = 0; i < rte_cryptodev_count (); i++) { u32 dev_sess_sz = rte_cryptodev_sym_get_private_session_size (i); sess_data_sz = dev_sess_sz > sess_data_sz ? dev_sess_sz : sess_data_sz; } return sess_data_sz; } static void dpdk_disable_cryptodev_engine (vlib_main_t * vm) { cryptodev_main_t *cmt = &cryptodev_main; cryptodev_numa_data_t *numa_data; vec_validate (cmt->per_numa_data, vm->numa_node); numa_data = vec_elt_at_index (cmt->per_numa_data, vm->numa_node); if (numa_data->sess_pool) rte_mempool_free (numa_data->sess_pool); if (numa_data->sess_priv_pool) rte_mempool_free (numa_data->sess_priv_pool); if (numa_data->cop_pool) rte_mempool_free (numa_data->cop_pool); } static void crypto_op_init (struct rte_mempool *mempool, void *_arg __attribute__ ((unused)), void *_obj, unsigned i __attribute__ ((unused))) { struct rte_crypto_op *op = _obj; op->sess_type = RTE_CRYPTO_OP_WITH_SESSION; op->type = RTE_CRYPTO_OP_TYPE_SYMMETRIC; op->status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED; op->phys_addr = rte_mempool_virt2iova (_obj); op->mempool = mempool; } clib_error_t * dpdk_cryptodev_init (vlib_main_t * vm) { cryptodev_main_t *cmt = &cryptodev_main; vlib_thread_main_t *tm = vlib_get_thread_main (); cryptodev_engine_thread_t *ptd; cryptodev_numa_data_t *numa_data; struct rte_mempool *mp; u32 skip_master = vlib_num_workers () > 0; u32 n_workers = tm->n_vlib_mains - skip_master; u32 numa = vm->numa_node; i32 sess_sz; u64 n_cop_elts; u32 eidx; u32 i; u8 *name = 0; clib_error_t *error; struct rte_crypto_op_pool_private *priv; cmt->iova_mode = rte_eal_iova_mode (); sess_sz = cryptodev_get_session_sz(vm, n_workers); if (sess_sz < 0) { error = clib_error_return (0, "Not enough cryptodevs"); return error; } /* A total of 4 times n_worker threads * frame size as crypto ops */ n_cop_elts = max_pow2 ((u64)n_workers * CRYPTODEV_NB_CRYPTO_OPS); vec_validate (cmt->per_numa_data, vm->numa_node); numa_data = vec_elt_at_index (cmt->per_numa_data, numa); /* create session pool for the numa node */ name = format (0, "vcryptodev_sess_pool_%u%c", numa, 0); mp = rte_cryptodev_sym_session_pool_create ((char *) name, CRYPTODEV_NB_SESSION, 0, 0, 0, numa); if (!mp) { error = clib_error_return (0, "Not enough memory for mp %s", name); goto err_handling; } vec_free (name); numa_data->sess_pool = mp; /* create session private pool for the numa node */ name = format (0, "cryptodev_sess_pool_%u%c", numa, 0); mp = rte_mempool_create ((char *) name, CRYPTODEV_NB_SESSION, sess_sz, 0, 0, NULL, NULL, NULL, NULL, numa, 0); if (!mp) { error = clib_error_return (0, "Not enough memory for mp %s", name); vec_free (name); goto err_handling; } vec_free (name); numa_data->sess_priv_pool = mp; /* create cryptodev op pool */ name = format (0, "cryptodev_op_pool_%u%c", numa, 0); mp = rte_mempool_create ((char *) name, n_cop_elts, sizeof (cryptodev_op_t), VLIB_FRAME_SIZE * 2, sizeof (struct rte_crypto_op_pool_private), NULL, NULL, crypto_op_init, NULL, numa, 0); if (!mp) { error = clib_error_return (0, "Not enough memory for mp %s", name); vec_free (name); goto err_handling; } priv = rte_mempool_get_priv (mp); priv->priv_size = sizeof (struct rte_crypto_op_pool_private); priv->type = RTE_CRYPTO_OP_TYPE_SYMMETRIC; vec_free (name); numa_data->cop_pool = mp; /* probe all cryptodev devices and get queue info */ if (cryptodev_probe (vm, n_workers) < 0) { error = clib_error_return (0, "Failed to configure cryptodev"); goto err_handling; } clib_bitmap_vec_validate (cmt->active_cdev_inst_mask, tm->n_vlib_mains); clib_spinlock_init (&cmt->tlock); vec_validate_aligned(cmt->per_thread_data, tm->n_vlib_mains - 1, CLIB_CACHE_LINE_BYTES); for (i = skip_master; i < tm->n_vlib_mains; i++) { ptd = cmt->per_thread_data + i; cryptodev_assign_resource (ptd, 0, CRYPTODEV_RESOURCE_ASSIGN_AUTO); name = format (0, "frames_ring_%u%c", i, 0); ptd->ring = rte_ring_create((char *) name, CRYPTODEV_NB_CRYPTO_OPS, vm->numa_node, RING_F_SP_ENQ|RING_F_SC_DEQ); if (!ptd->ring) { error = clib_error_return (0, "Not enough memory for mp %s", name); vec_free (name); goto err_handling; } vec_validate (ptd->cops, VNET_CRYPTO_FRAME_SIZE - 1); vec_free(name); } /* register handler */ eidx = vnet_crypto_register_engine (vm, "dpdk_cryptodev", 79, "DPDK Cryptodev Engine"); #define _(a, b, c, d, e, f) \ vnet_crypto_register_async_handler \ (vm, eidx, VNET_CRYPTO_OP_##a##_TAG##e##_AAD##f##_ENC, \ cryptodev_enqueue_gcm_aad_##f##_enc,\ cryptodev_frame_dequeue); \ vnet_crypto_register_async_handler \ (vm, eidx, VNET_CRYPTO_OP_##a##_TAG##e##_AAD##f##_DEC, \ cryptodev_enqueue_gcm_aad_##f##_dec, \ cryptodev_frame_dequeue); foreach_vnet_aead_crypto_conversion #undef _ #define _(a, b, c, d) \ vnet_crypto_register_async_handler \ (vm, eidx, VNET_CRYPTO_OP_##a##_##c##_TAG##d##_ENC, \ cryptodev_enqueue_linked_alg_enc, \ cryptodev_frame_dequeue); \ vnet_crypto_register_async_handler \ (vm, eidx, VNET_CRYPTO_OP_##a##_##c##_TAG##d##_DEC, \ cryptodev_enqueue_linked_alg_dec, \ cryptodev_frame_dequeue); foreach_cryptodev_link_async_alg #undef _ vnet_crypto_register_key_handler (vm, eidx, cryptodev_key_handler); return 0; err_handling: dpdk_disable_cryptodev_engine (vm); return error; } /* *INDENT-On* */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */