1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright (c) 2021 NVIDIA Corporation & Affiliates
5 #include <rte_malloc.h>
6 #include <rte_mempool.h>
10 #include <rte_memory.h>
12 #include <mlx5_glue.h>
13 #include <mlx5_common.h>
14 #include <mlx5_common_pci.h>
15 #include <mlx5_devx_cmds.h>
16 #include <mlx5_common_os.h>
18 #include "mlx5_crypto_utils.h"
19 #include "mlx5_crypto.h"
21 #define MLX5_CRYPTO_DRIVER_NAME crypto_mlx5
22 #define MLX5_CRYPTO_LOG_NAME pmd.crypto.mlx5
23 #define MLX5_CRYPTO_MAX_QPS 1024
25 #define MLX5_CRYPTO_FEATURE_FLAGS \
26 (RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO | RTE_CRYPTODEV_FF_HW_ACCELERATED | \
27 RTE_CRYPTODEV_FF_CIPHER_WRAPPED_KEY | \
28 RTE_CRYPTODEV_FF_CIPHER_MULTIPLE_DATA_UNITS)
30 TAILQ_HEAD(mlx5_crypto_privs, mlx5_crypto_priv) mlx5_crypto_priv_list =
31 TAILQ_HEAD_INITIALIZER(mlx5_crypto_priv_list);
32 static pthread_mutex_t priv_list_lock = PTHREAD_MUTEX_INITIALIZER;
34 int mlx5_crypto_logtype;
36 uint8_t mlx5_crypto_driver_id;
38 const struct rte_cryptodev_capabilities mlx5_crypto_caps[] = {
40 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
42 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
44 .algo = RTE_CRYPTO_CIPHER_AES_XTS,
57 RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_512_BYTES |
58 RTE_CRYPTO_CIPHER_DATA_UNIT_LEN_4096_BYTES,
64 static const char mlx5_crypto_drv_name[] = RTE_STR(MLX5_CRYPTO_DRIVER_NAME);
66 static const struct rte_driver mlx5_drv = {
67 .name = mlx5_crypto_drv_name,
68 .alias = mlx5_crypto_drv_name
71 static struct cryptodev_driver mlx5_cryptodev_driver;
73 struct mlx5_crypto_session {
74 uint32_t bs_bpt_eo_es;
75 /**< bsf_size, bsf_p_type, encryption_order and encryption standard,
76 * saved in big endian format.
79 /**< crypto_block_size_pointer and reserved 24 bits saved in big
82 uint32_t iv_offset:16;
83 /**< Starting point for Initialisation Vector. */
84 struct mlx5_crypto_dek *dek; /**< Pointer to dek struct. */
85 uint32_t dek_id; /**< DEK ID */
89 mlx5_crypto_dev_infos_get(struct rte_cryptodev *dev,
90 struct rte_cryptodev_info *dev_info)
93 if (dev_info != NULL) {
94 dev_info->driver_id = mlx5_crypto_driver_id;
95 dev_info->feature_flags = MLX5_CRYPTO_FEATURE_FLAGS;
96 dev_info->capabilities = mlx5_crypto_caps;
97 dev_info->max_nb_queue_pairs = MLX5_CRYPTO_MAX_QPS;
98 dev_info->min_mbuf_headroom_req = 0;
99 dev_info->min_mbuf_tailroom_req = 0;
100 dev_info->sym.max_nb_sessions = 0;
102 * If 0, the device does not have any limitation in number of
103 * sessions that can be used.
109 mlx5_crypto_dev_configure(struct rte_cryptodev *dev,
110 struct rte_cryptodev_config *config)
112 struct mlx5_crypto_priv *priv = dev->data->dev_private;
114 if (config == NULL) {
115 DRV_LOG(ERR, "Invalid crypto dev configure parameters.");
118 if ((config->ff_disable & RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO) != 0) {
120 "Disabled symmetric crypto feature is not supported.");
123 if (mlx5_crypto_dek_setup(priv) != 0) {
124 DRV_LOG(ERR, "Dek hash list creation has failed.");
127 priv->dev_config = *config;
128 DRV_LOG(DEBUG, "Device %u was configured.", dev->driver_id);
133 mlx5_crypto_dev_stop(struct rte_cryptodev *dev)
139 mlx5_crypto_dev_start(struct rte_cryptodev *dev)
146 mlx5_crypto_dev_close(struct rte_cryptodev *dev)
148 struct mlx5_crypto_priv *priv = dev->data->dev_private;
150 mlx5_crypto_dek_unset(priv);
151 DRV_LOG(DEBUG, "Device %u was closed.", dev->driver_id);
156 mlx5_crypto_sym_session_get_size(struct rte_cryptodev *dev __rte_unused)
158 return sizeof(struct mlx5_crypto_session);
162 mlx5_crypto_sym_session_configure(struct rte_cryptodev *dev,
163 struct rte_crypto_sym_xform *xform,
164 struct rte_cryptodev_sym_session *session,
165 struct rte_mempool *mp)
167 struct mlx5_crypto_priv *priv = dev->data->dev_private;
168 struct mlx5_crypto_session *sess_private_data;
169 struct rte_crypto_cipher_xform *cipher;
170 uint8_t encryption_order;
173 if (unlikely(xform->next != NULL)) {
174 DRV_LOG(ERR, "Xform next is not supported.");
177 if (unlikely((xform->type != RTE_CRYPTO_SYM_XFORM_CIPHER) ||
178 (xform->cipher.algo != RTE_CRYPTO_CIPHER_AES_XTS))) {
179 DRV_LOG(ERR, "Only AES-XTS algorithm is supported.");
182 ret = rte_mempool_get(mp, (void *)&sess_private_data);
185 "Failed to get session %p private data from mempool.",
189 cipher = &xform->cipher;
190 sess_private_data->dek = mlx5_crypto_dek_prepare(priv, cipher);
191 if (sess_private_data->dek == NULL) {
192 rte_mempool_put(mp, sess_private_data);
193 DRV_LOG(ERR, "Failed to prepare dek.");
196 if (cipher->op == RTE_CRYPTO_CIPHER_OP_ENCRYPT)
197 encryption_order = MLX5_ENCRYPTION_ORDER_ENCRYPTED_RAW_MEMORY;
199 encryption_order = MLX5_ENCRYPTION_ORDER_ENCRYPTED_RAW_WIRE;
200 sess_private_data->bs_bpt_eo_es = rte_cpu_to_be_32
201 (MLX5_BSF_SIZE_64B << MLX5_BSF_SIZE_OFFSET |
202 MLX5_BSF_P_TYPE_CRYPTO << MLX5_BSF_P_TYPE_OFFSET |
203 encryption_order << MLX5_ENCRYPTION_ORDER_OFFSET |
204 MLX5_ENCRYPTION_STANDARD_AES_XTS);
205 switch (xform->cipher.dataunit_len) {
207 sess_private_data->bsp_res = 0;
210 sess_private_data->bsp_res = rte_cpu_to_be_32
211 ((uint32_t)MLX5_BLOCK_SIZE_512B <<
212 MLX5_BLOCK_SIZE_OFFSET);
215 sess_private_data->bsp_res = rte_cpu_to_be_32
216 ((uint32_t)MLX5_BLOCK_SIZE_4096B <<
217 MLX5_BLOCK_SIZE_OFFSET);
220 DRV_LOG(ERR, "Cipher data unit length is not supported.");
223 sess_private_data->iv_offset = cipher->iv.offset;
224 sess_private_data->dek_id =
225 rte_cpu_to_be_32(sess_private_data->dek->obj->id &
227 set_sym_session_private_data(session, dev->driver_id,
229 DRV_LOG(DEBUG, "Session %p was configured.", sess_private_data);
234 mlx5_crypto_sym_session_clear(struct rte_cryptodev *dev,
235 struct rte_cryptodev_sym_session *sess)
237 struct mlx5_crypto_priv *priv = dev->data->dev_private;
238 struct mlx5_crypto_session *spriv = get_sym_session_private_data(sess,
241 if (unlikely(spriv == NULL)) {
242 DRV_LOG(ERR, "Failed to get session %p private data.", spriv);
245 mlx5_crypto_dek_destroy(priv, spriv->dek);
246 set_sym_session_private_data(sess, dev->driver_id, NULL);
247 rte_mempool_put(rte_mempool_from_obj(spriv), spriv);
248 DRV_LOG(DEBUG, "Session %p was cleared.", spriv);
252 mlx5_crypto_queue_pair_release(struct rte_cryptodev *dev, uint16_t qp_id)
254 struct mlx5_crypto_qp *qp = dev->data->queue_pairs[qp_id];
256 if (qp->qp_obj != NULL)
257 claim_zero(mlx5_devx_cmd_destroy(qp->qp_obj));
258 if (qp->umem_obj != NULL)
259 claim_zero(mlx5_glue->devx_umem_dereg(qp->umem_obj));
260 if (qp->umem_buf != NULL)
261 rte_free(qp->umem_buf);
262 mlx5_mr_btree_free(&qp->mr_ctrl.cache_bh);
263 mlx5_devx_cq_destroy(&qp->cq_obj);
265 dev->data->queue_pairs[qp_id] = NULL;
270 mlx5_crypto_qp2rts(struct mlx5_crypto_qp *qp)
273 * In Order to configure self loopback, when calling these functions the
274 * remote QP id that is used is the id of the same QP.
276 if (mlx5_devx_cmd_modify_qp_state(qp->qp_obj, MLX5_CMD_OP_RST2INIT_QP,
278 DRV_LOG(ERR, "Failed to modify QP to INIT state(%u).",
282 if (mlx5_devx_cmd_modify_qp_state(qp->qp_obj, MLX5_CMD_OP_INIT2RTR_QP,
284 DRV_LOG(ERR, "Failed to modify QP to RTR state(%u).",
288 if (mlx5_devx_cmd_modify_qp_state(qp->qp_obj, MLX5_CMD_OP_RTR2RTS_QP,
290 DRV_LOG(ERR, "Failed to modify QP to RTS state(%u).",
298 mlx5_crypto_queue_pair_setup(struct rte_cryptodev *dev, uint16_t qp_id,
299 const struct rte_cryptodev_qp_conf *qp_conf,
302 struct mlx5_crypto_priv *priv = dev->data->dev_private;
303 struct mlx5_devx_qp_attr attr = {0};
304 struct mlx5_crypto_qp *qp;
305 uint16_t log_nb_desc = rte_log2_u32(qp_conf->nb_descriptors);
306 uint32_t umem_size = RTE_BIT32(log_nb_desc) *
307 MLX5_CRYPTO_WQE_SET_SIZE +
308 sizeof(*qp->db_rec) * 2;
309 uint32_t alloc_size = sizeof(*qp);
310 struct mlx5_devx_cq_attr cq_attr = {
311 .uar_page_id = mlx5_os_get_devx_uar_page_id(priv->uar),
314 if (dev->data->queue_pairs[qp_id] != NULL)
315 mlx5_crypto_queue_pair_release(dev, qp_id);
316 alloc_size = RTE_ALIGN(alloc_size, RTE_CACHE_LINE_SIZE);
317 alloc_size += sizeof(struct rte_crypto_op *) * RTE_BIT32(log_nb_desc);
318 qp = rte_zmalloc_socket(__func__, alloc_size, RTE_CACHE_LINE_SIZE,
321 DRV_LOG(ERR, "Failed to allocate QP memory.");
325 if (mlx5_devx_cq_create(priv->ctx, &qp->cq_obj, log_nb_desc,
326 &cq_attr, socket_id) != 0) {
327 DRV_LOG(ERR, "Failed to create CQ.");
330 qp->umem_buf = rte_zmalloc_socket(__func__, umem_size, 4096, socket_id);
331 if (qp->umem_buf == NULL) {
332 DRV_LOG(ERR, "Failed to allocate QP umem.");
336 qp->umem_obj = mlx5_glue->devx_umem_reg(priv->ctx,
337 (void *)(uintptr_t)qp->umem_buf,
339 IBV_ACCESS_LOCAL_WRITE);
340 if (qp->umem_obj == NULL) {
341 DRV_LOG(ERR, "Failed to register QP umem.");
344 if (mlx5_mr_btree_init(&qp->mr_ctrl.cache_bh, MLX5_MR_BTREE_CACHE_N,
345 priv->dev_config.socket_id) != 0) {
346 DRV_LOG(ERR, "Cannot allocate MR Btree for qp %u.",
351 qp->mr_ctrl.dev_gen_ptr = &priv->mr_scache.dev_gen;
353 attr.uar_index = mlx5_os_get_devx_uar_page_id(priv->uar);
354 attr.cqn = qp->cq_obj.cq->id;
355 attr.log_page_size = rte_log2_u32(sysconf(_SC_PAGESIZE));
357 attr.sq_size = RTE_BIT32(log_nb_desc);
358 attr.dbr_umem_valid = 1;
359 attr.wq_umem_id = qp->umem_obj->umem_id;
360 attr.wq_umem_offset = 0;
361 attr.dbr_umem_id = qp->umem_obj->umem_id;
362 attr.dbr_address = RTE_BIT64(log_nb_desc) *
363 MLX5_CRYPTO_WQE_SET_SIZE;
364 qp->qp_obj = mlx5_devx_cmd_create_qp(priv->ctx, &attr);
365 if (qp->qp_obj == NULL) {
366 DRV_LOG(ERR, "Failed to create QP(%u).", rte_errno);
369 qp->db_rec = RTE_PTR_ADD(qp->umem_buf, (uintptr_t)attr.dbr_address);
370 if (mlx5_crypto_qp2rts(qp))
372 qp->ops = (struct rte_crypto_op **)RTE_ALIGN((uintptr_t)(qp + 1),
373 RTE_CACHE_LINE_SIZE);
374 dev->data->queue_pairs[qp_id] = qp;
377 mlx5_crypto_queue_pair_release(dev, qp_id);
381 static struct rte_cryptodev_ops mlx5_crypto_ops = {
382 .dev_configure = mlx5_crypto_dev_configure,
383 .dev_start = mlx5_crypto_dev_start,
384 .dev_stop = mlx5_crypto_dev_stop,
385 .dev_close = mlx5_crypto_dev_close,
386 .dev_infos_get = mlx5_crypto_dev_infos_get,
389 .queue_pair_setup = mlx5_crypto_queue_pair_setup,
390 .queue_pair_release = mlx5_crypto_queue_pair_release,
391 .sym_session_get_size = mlx5_crypto_sym_session_get_size,
392 .sym_session_configure = mlx5_crypto_sym_session_configure,
393 .sym_session_clear = mlx5_crypto_sym_session_clear,
394 .sym_get_raw_dp_ctx_size = NULL,
395 .sym_configure_raw_dp_ctx = NULL,
399 mlx5_crypto_hw_global_release(struct mlx5_crypto_priv *priv)
401 if (priv->pd != NULL) {
402 claim_zero(mlx5_glue->dealloc_pd(priv->pd));
405 if (priv->uar != NULL) {
406 mlx5_glue->devx_free_uar(priv->uar);
412 mlx5_crypto_pd_create(struct mlx5_crypto_priv *priv)
414 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
415 struct mlx5dv_obj obj;
416 struct mlx5dv_pd pd_info;
419 priv->pd = mlx5_glue->alloc_pd(priv->ctx);
420 if (priv->pd == NULL) {
421 DRV_LOG(ERR, "Failed to allocate PD.");
422 return errno ? -errno : -ENOMEM;
424 obj.pd.in = priv->pd;
425 obj.pd.out = &pd_info;
426 ret = mlx5_glue->dv_init_obj(&obj, MLX5DV_OBJ_PD);
428 DRV_LOG(ERR, "Fail to get PD object info.");
429 mlx5_glue->dealloc_pd(priv->pd);
433 priv->pdn = pd_info.pdn;
437 DRV_LOG(ERR, "Cannot get pdn - no DV support.");
439 #endif /* HAVE_IBV_FLOW_DV_SUPPORT */
443 mlx5_crypto_hw_global_prepare(struct mlx5_crypto_priv *priv)
445 if (mlx5_crypto_pd_create(priv) != 0)
447 priv->uar = mlx5_devx_alloc_uar(priv->ctx, -1);
448 if (priv->uar == NULL || mlx5_os_get_devx_uar_reg_addr(priv->uar) ==
451 claim_zero(mlx5_glue->dealloc_pd(priv->pd));
452 DRV_LOG(ERR, "Failed to allocate UAR.");
459 * Callback for memory event.
469 mlx5_crypto_mr_mem_event_cb(enum rte_mem_event event_type, const void *addr,
470 size_t len, void *arg __rte_unused)
472 struct mlx5_crypto_priv *priv;
474 /* Must be called from the primary process. */
475 MLX5_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
476 switch (event_type) {
477 case RTE_MEM_EVENT_FREE:
478 pthread_mutex_lock(&priv_list_lock);
479 /* Iterate all the existing mlx5 devices. */
480 TAILQ_FOREACH(priv, &mlx5_crypto_priv_list, next)
481 mlx5_free_mr_by_addr(&priv->mr_scache,
482 priv->ctx->device->name,
484 pthread_mutex_unlock(&priv_list_lock);
486 case RTE_MEM_EVENT_ALLOC:
493 * DPDK callback to register a PCI device.
495 * This function spawns crypto device out of a given PCI device.
498 * PCI driver structure (mlx5_crypto_driver).
500 * PCI device information.
503 * 0 on success, 1 to skip this driver, a negative errno value otherwise
504 * and rte_errno is set.
507 mlx5_crypto_pci_probe(struct rte_pci_driver *pci_drv,
508 struct rte_pci_device *pci_dev)
510 struct ibv_device *ibv;
511 struct rte_cryptodev *crypto_dev;
512 struct ibv_context *ctx;
513 struct mlx5_crypto_priv *priv;
514 struct mlx5_hca_attr attr = { 0 };
515 struct rte_cryptodev_pmd_init_params init_params = {
517 .private_data_size = sizeof(struct mlx5_crypto_priv),
518 .socket_id = pci_dev->device.numa_node,
519 .max_nb_queue_pairs =
520 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS,
522 RTE_SET_USED(pci_drv);
523 if (rte_eal_process_type() != RTE_PROC_PRIMARY) {
524 DRV_LOG(ERR, "Non-primary process type is not supported.");
528 ibv = mlx5_os_get_ibv_device(&pci_dev->addr);
530 DRV_LOG(ERR, "No matching IB device for PCI slot "
531 PCI_PRI_FMT ".", pci_dev->addr.domain,
532 pci_dev->addr.bus, pci_dev->addr.devid,
533 pci_dev->addr.function);
536 DRV_LOG(INFO, "PCI information matches for device \"%s\".", ibv->name);
537 ctx = mlx5_glue->dv_open_device(ibv);
539 DRV_LOG(ERR, "Failed to open IB device \"%s\".", ibv->name);
543 if (mlx5_devx_cmd_query_hca_attr(ctx, &attr) != 0 ||
544 attr.crypto == 0 || attr.aes_xts == 0) {
545 DRV_LOG(ERR, "Not enough capabilities to support crypto "
546 "operations, maybe old FW/OFED version?");
547 claim_zero(mlx5_glue->close_device(ctx));
551 crypto_dev = rte_cryptodev_pmd_create(ibv->name, &pci_dev->device,
553 if (crypto_dev == NULL) {
554 DRV_LOG(ERR, "Failed to create device \"%s\".", ibv->name);
555 claim_zero(mlx5_glue->close_device(ctx));
559 "Crypto device %s was created successfully.", ibv->name);
560 crypto_dev->dev_ops = &mlx5_crypto_ops;
561 crypto_dev->dequeue_burst = NULL;
562 crypto_dev->enqueue_burst = NULL;
563 crypto_dev->feature_flags = MLX5_CRYPTO_FEATURE_FLAGS;
564 crypto_dev->driver_id = mlx5_crypto_driver_id;
565 priv = crypto_dev->data->dev_private;
567 priv->pci_dev = pci_dev;
568 priv->crypto_dev = crypto_dev;
569 if (mlx5_crypto_hw_global_prepare(priv) != 0) {
570 rte_cryptodev_pmd_destroy(priv->crypto_dev);
571 claim_zero(mlx5_glue->close_device(priv->ctx));
574 if (mlx5_mr_btree_init(&priv->mr_scache.cache,
575 MLX5_MR_BTREE_CACHE_N * 2, rte_socket_id()) != 0) {
576 DRV_LOG(ERR, "Failed to allocate shared cache MR memory.");
577 mlx5_crypto_hw_global_release(priv);
578 rte_cryptodev_pmd_destroy(priv->crypto_dev);
579 claim_zero(mlx5_glue->close_device(priv->ctx));
583 priv->mr_scache.reg_mr_cb = mlx5_common_verbs_reg_mr;
584 priv->mr_scache.dereg_mr_cb = mlx5_common_verbs_dereg_mr;
585 /* Register callback function for global shared MR cache management. */
586 if (TAILQ_EMPTY(&mlx5_crypto_priv_list))
587 rte_mem_event_callback_register("MLX5_MEM_EVENT_CB",
588 mlx5_crypto_mr_mem_event_cb,
590 pthread_mutex_lock(&priv_list_lock);
591 TAILQ_INSERT_TAIL(&mlx5_crypto_priv_list, priv, next);
592 pthread_mutex_unlock(&priv_list_lock);
597 mlx5_crypto_pci_remove(struct rte_pci_device *pdev)
599 struct mlx5_crypto_priv *priv = NULL;
601 pthread_mutex_lock(&priv_list_lock);
602 TAILQ_FOREACH(priv, &mlx5_crypto_priv_list, next)
603 if (rte_pci_addr_cmp(&priv->pci_dev->addr, &pdev->addr) != 0)
606 TAILQ_REMOVE(&mlx5_crypto_priv_list, priv, next);
607 pthread_mutex_unlock(&priv_list_lock);
609 if (TAILQ_EMPTY(&mlx5_crypto_priv_list))
610 rte_mem_event_callback_unregister("MLX5_MEM_EVENT_CB",
612 mlx5_mr_release_cache(&priv->mr_scache);
613 mlx5_crypto_hw_global_release(priv);
614 rte_cryptodev_pmd_destroy(priv->crypto_dev);
615 claim_zero(mlx5_glue->close_device(priv->ctx));
620 static const struct rte_pci_id mlx5_crypto_pci_id_map[] = {
622 RTE_PCI_DEVICE(PCI_VENDOR_ID_MELLANOX,
623 PCI_DEVICE_ID_MELLANOX_CONNECTX6)
630 static struct mlx5_pci_driver mlx5_crypto_driver = {
631 .driver_class = MLX5_CLASS_CRYPTO,
634 .name = RTE_STR(MLX5_CRYPTO_DRIVER_NAME),
636 .id_table = mlx5_crypto_pci_id_map,
637 .probe = mlx5_crypto_pci_probe,
638 .remove = mlx5_crypto_pci_remove,
643 RTE_INIT(rte_mlx5_crypto_init)
646 if (mlx5_glue != NULL)
647 mlx5_pci_driver_register(&mlx5_crypto_driver);
650 RTE_PMD_REGISTER_CRYPTO_DRIVER(mlx5_cryptodev_driver, mlx5_drv,
651 mlx5_crypto_driver_id);
653 RTE_LOG_REGISTER_DEFAULT(mlx5_crypto_logtype, NOTICE)
654 RTE_PMD_EXPORT_NAME(MLX5_CRYPTO_DRIVER_NAME, __COUNTER__);
655 RTE_PMD_REGISTER_PCI_TABLE(MLX5_CRYPTO_DRIVER_NAME, mlx5_crypto_pci_id_map);
656 RTE_PMD_REGISTER_KMOD_DEP(MLX5_CRYPTO_DRIVER_NAME, "* ib_uverbs & mlx5_core & mlx5_ib");