crypto/mlx5: add memory region management

Mellanox user space drivers don't deal with physical addresses as part
of a memory protection mechanism.
The device translates the given virtual address to a physical address
using the given memory key as an address space identifier.
That's why any mbuf virtual address is moved directly to the HW
descriptor(WQE).

The mapping between the virtual address to the physical address is saved
in MR configured by the kernel to the HW.

Each MR has a key that should also be moved to the WQE by the SW.

When the SW sees an unmapped address, it extends the address range and
creates a MR using a system call.

Add memory region cache management:
	- 2 level cache per queue-pair - no locks.
	- 1 shared cache between all the queues using a lock.

Using this way, the MR key search per data-path address is optimized.

Signed-off-by: Shiri Kuzin <shirik@nvidia.com>
Signed-off-by: Michael Baum <michaelba@nvidia.com>
Acked-by: Matan Azrad <matan@nvidia.com>
Acked-by: Akhil Goyal <gakhil@marvell.com>

diff --git a/doc/guides/cryptodevs/mlx5.rst b/doc/guides/cryptodevs/mlx5.rst
index ed60a93..ebaae08 100644 (file)
--- a/doc/guides/cryptodevs/mlx5.rst
+++ b/doc/guides/cryptodevs/mlx5.rst
@@ -28,6 +28,12 @@ when the MKEY is configured to perform crypto operations.
 
 The encryption does not require text to be aligned to the AES block size (128b).
 
+For security reasons and to increase robustness, this driver only deals with virtual
+memory addresses. The way resources allocations are handled by the kernel,
+combined with hardware specifications that allow handling virtual memory
+addresses directly, ensure that DPDK applications cannot access random
+physical memory (or memory that does not belong to the current process).
+
 The PMD uses ``libibverbs`` and ``libmlx5`` to access the device firmware
 or to access the hardware components directly.
 There are different levels of objects and bypassing abilities.

diff --git a/drivers/crypto/mlx5/mlx5_crypto.c b/drivers/crypto/mlx5/mlx5_crypto.c
index 2fe2e8b..9416590 100644 (file)
--- a/drivers/crypto/mlx5/mlx5_crypto.c
+++ b/drivers/crypto/mlx5/mlx5_crypto.c
@@ -259,6 +259,7 @@ mlx5_crypto_queue_pair_release(struct rte_cryptodev *dev, uint16_t qp_id)
                claim_zero(mlx5_glue->devx_umem_dereg(qp->umem_obj));
        if (qp->umem_buf != NULL)
                rte_free(qp->umem_buf);
+       mlx5_mr_btree_free(&qp->mr_ctrl.cache_bh);
        mlx5_devx_cq_destroy(&qp->cq_obj);
        rte_free(qp);
        dev->data->queue_pairs[qp_id] = NULL;
@@ -340,6 +341,14 @@ mlx5_crypto_queue_pair_setup(struct rte_cryptodev *dev, uint16_t qp_id,
                DRV_LOG(ERR, "Failed to register QP umem.");
                goto error;
        }
+       if (mlx5_mr_btree_init(&qp->mr_ctrl.cache_bh, MLX5_MR_BTREE_CACHE_N,
+                              priv->dev_config.socket_id) != 0) {
+               DRV_LOG(ERR, "Cannot allocate MR Btree for qp %u.",
+                       (uint32_t)qp_id);
+               rte_errno = ENOMEM;
+               goto error;
+       }
+       qp->mr_ctrl.dev_gen_ptr = &priv->mr_scache.dev_gen;
        attr.pd = priv->pdn;
        attr.uar_index = mlx5_os_get_devx_uar_page_id(priv->uar);
        attr.cqn = qp->cq_obj.cq->id;
@@ -446,6 +455,40 @@ mlx5_crypto_hw_global_prepare(struct mlx5_crypto_priv *priv)
        return 0;
 }
 
+/**
+ * Callback for memory event.
+ *
+ * @param event_type
+ *   Memory event type.
+ * @param addr
+ *   Address of memory.
+ * @param len
+ *   Size of memory.
+ */
+static void
+mlx5_crypto_mr_mem_event_cb(enum rte_mem_event event_type, const void *addr,
+                           size_t len, void *arg __rte_unused)
+{
+       struct mlx5_crypto_priv *priv;
+
+       /* Must be called from the primary process. */
+       MLX5_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
+       switch (event_type) {
+       case RTE_MEM_EVENT_FREE:
+               pthread_mutex_lock(&priv_list_lock);
+               /* Iterate all the existing mlx5 devices. */
+               TAILQ_FOREACH(priv, &mlx5_crypto_priv_list, next)
+                       mlx5_free_mr_by_addr(&priv->mr_scache,
+                                            priv->ctx->device->name,
+                                            addr, len);
+               pthread_mutex_unlock(&priv_list_lock);
+               break;
+       case RTE_MEM_EVENT_ALLOC:
+       default:
+               break;
+       }
+}
+
 /**
  * DPDK callback to register a PCI device.
  *
@@ -528,6 +571,22 @@ mlx5_crypto_pci_probe(struct rte_pci_driver *pci_drv,
                claim_zero(mlx5_glue->close_device(priv->ctx));
                return -1;
        }
+       if (mlx5_mr_btree_init(&priv->mr_scache.cache,
+                            MLX5_MR_BTREE_CACHE_N * 2, rte_socket_id()) != 0) {
+               DRV_LOG(ERR, "Failed to allocate shared cache MR memory.");
+               mlx5_crypto_hw_global_release(priv);
+               rte_cryptodev_pmd_destroy(priv->crypto_dev);
+               claim_zero(mlx5_glue->close_device(priv->ctx));
+               rte_errno = ENOMEM;
+               return -rte_errno;
+       }
+       priv->mr_scache.reg_mr_cb = mlx5_common_verbs_reg_mr;
+       priv->mr_scache.dereg_mr_cb = mlx5_common_verbs_dereg_mr;
+       /* Register callback function for global shared MR cache management. */
+       if (TAILQ_EMPTY(&mlx5_crypto_priv_list))
+               rte_mem_event_callback_register("MLX5_MEM_EVENT_CB",
+                                               mlx5_crypto_mr_mem_event_cb,
+                                               NULL);
        pthread_mutex_lock(&priv_list_lock);
        TAILQ_INSERT_TAIL(&mlx5_crypto_priv_list, priv, next);
        pthread_mutex_unlock(&priv_list_lock);
@@ -547,6 +606,10 @@ mlx5_crypto_pci_remove(struct rte_pci_device *pdev)
                TAILQ_REMOVE(&mlx5_crypto_priv_list, priv, next);
        pthread_mutex_unlock(&priv_list_lock);
        if (priv) {
+               if (TAILQ_EMPTY(&mlx5_crypto_priv_list))
+                       rte_mem_event_callback_unregister("MLX5_MEM_EVENT_CB",
+                                                         NULL);
+               mlx5_mr_release_cache(&priv->mr_scache);
                mlx5_crypto_hw_global_release(priv);
                rte_cryptodev_pmd_destroy(priv->crypto_dev);
                claim_zero(mlx5_glue->close_device(priv->ctx));

diff --git a/drivers/crypto/mlx5/mlx5_crypto.h b/drivers/crypto/mlx5/mlx5_crypto.h
index 949092c..af292ed 100644 (file)
--- a/drivers/crypto/mlx5/mlx5_crypto.h
+++ b/drivers/crypto/mlx5/mlx5_crypto.h
@@ -12,6 +12,7 @@
 
 #include <mlx5_common_utils.h>
 #include <mlx5_common_devx.h>
+#include <mlx5_common_mr.h>
 
 #define MLX5_CRYPTO_DEK_HTABLE_SZ (1 << 11)
 #define MLX5_CRYPTO_KEY_LENGTH 80
@@ -27,6 +28,7 @@ struct mlx5_crypto_priv {
        struct ibv_pd *pd;
        struct mlx5_hlist *dek_hlist; /* Dek hash list. */
        struct rte_cryptodev_config dev_config;
+       struct mlx5_mr_share_cache mr_scache; /* Global shared MR cache. */
 };
 
 struct mlx5_crypto_qp {
@@ -36,6 +38,7 @@ struct mlx5_crypto_qp {
        void *umem_buf;
        volatile uint32_t *db_rec;
        struct rte_crypto_op **ops;
+       struct mlx5_mr_ctrl mr_ctrl;
 };
 
 struct mlx5_crypto_dek {