module/accel: Add mlx5 accel module (a1dfa7ec) · Commits · Public Repositories / spdk

CHANGELOG.md

+3 −0

Original line number	Diff line number	Diff line
		@@ -11,6 +11,9 @@ New functions `spdk_accel_submit_encrypt` and `spdk_accel_submit_decrypt` were a
		New accel module `dpdk_cryptodev` has been added. It uses DPDK crypto PMD and support encrypt and
		decrypt operations. New RPC `dpdk_cryptodev_scan_accel_module` has been added to enable this accel module.

		New accel module `mlx5` was added. It implements crypto operations, enabled when SPDK is configured with
		RDMA provider is mlx5_dv and crypto support.

		### bdev

		Added RPCs bdev_nvme_start_mdns_discovery, bdev_nvme_get_mdns_discovery_info and

configure

+10 −6

Original line number	Diff line number	Diff line
		@@ -874,12 +874,16 @@ than or equal to 4.14 will see significantly reduced performance.
		fi

		if [ "${CONFIG[RDMA_PROV]}" == "mlx5_dv" ]; then
		if ! echo -e '#include <spdk/stdinc.h>\n' \
		'#include <infiniband/mlx5dv.h>\n' \
		'#include <rdma/rdma_cma.h>\n' \
		'int main(void) { return rdma_establish(NULL) \|\| ' \
		'!!IBV_QP_INIT_ATTR_SEND_OPS_FLAGS \|\| !!MLX5_OPCODE_RDMA_WRITE; }\n' \
		\| "${BUILD_CMD[@]}" -lmlx5 -I${rootdir}/include -c - 2> /dev/null; then
		MLX5_DV_BUILD_BUILD_CMD="
		#include <infiniband/mlx5dv.h>\n
		#include <rdma/rdma_cma.h>\n
		int main(void) { return rdma_establish(NULL) \|\|\n
		!!IBV_QP_INIT_ATTR_SEND_OPS_FLAGS \|\| !!MLX5_OPCODE_RDMA_WRITE"
		if [ "${CONFIG[CRYPTO]}" = "y" ]; then
		MLX5_DV_BUILD_BUILD_CMD+="\|\| !!MLX5DV_CRYPTO_ENGINES_CAP_AES_XTS_SINGLE_BLOCK"
		fi
		MLX5_DV_BUILD_BUILD_CMD+=";}"
		if ! echo -e $MLX5_DV_BUILD_BUILD_CMD \| "${BUILD_CMD[@]}" -lmlx5 -I${rootdir}/include -c -; then
		echo "mlx5_dv provider is not supported"
		exit 1
		fi

doc/jsonrpc.md

+38 −0

Original line number	Diff line number	Diff line
		@@ -450,6 +450,7 @@ Example response:
		"dpdk_cryptodev_scan_accel_module",
		"dpdk_cryptodev_set_driver",
		"dpdk_cryptodev_get_driver",
		"mlx5_scan_accel_module",
		"bdev_virtio_attach_controller",
		"bdev_virtio_scsi_get_devices",
		"bdev_virtio_detach_controller",
		@@ -2132,6 +2133,43 @@ Example response:
		}
		~~~

		### mlx5_scan_accel_module {#rpc_mlx5_scan_accel_module}

		Enable mlx5 accel offload

		#### Parameters

		Name \| Optional \| Type \| Description
		----------------------- \| -------- \|--------\| -----------
		qp_size \| Optional \| number \| qpair size
		num_requests \| Optional \| number \| Size of the shared requests pool

		#### Example

		Example request:

		~~~json
		{
		"jsonrpc": "2.0",
		"method": "mlx5_scan_accel_module",
		"id": 1,
		"params": {
		"qp_size": 256,
		"num_requests": 2047
		}
		}
		~~~

		Example response:

		~~~json
		{
		"jsonrpc": "2.0",
		"id": 1,
		"result": true
		}
		~~~

		## Block Device Abstraction Layer {#jsonrpc_components_bdev}

		### bdev_set_options {#rpc_bdev_set_options}

include/spdk_internal/mlx5.h

0 → 100644

+69 −0

Original line number	Diff line number	Diff line
		/* SPDX-License-Identifier: BSD-3-Clause
		* Copyright (c) 2022, NVIDIA CORPORATION & AFFILIATES.
		* All rights reserved.
		*/

		#ifndef SPDK_MLX5_H
		#define SPDK_MLX5_H

		#include <infiniband/mlx5dv.h>

		struct spdk_mlx5_crypto_dek;
		struct spdk_mlx5_crypto_keytag;

		struct spdk_mlx5_crypto_dek_create_attr {
		/* Data Encryption Key in binary form */
		char *dek;
		/* Length of the dek */
		size_t dek_len;
		};

		/**
		* Return a NULL terminated array of devices which support crypto operation on Nvidia NICs
		*
		* \param dev_num The size of the array or 0
		* \return Array of contexts. This array must be released with \b spdk_mlx5_crypto_devs_release
		*/
		struct ibv_context *spdk_mlx5_crypto_devs_get(int dev_num);

		/**
		* Releases array of devices allocated by \b spdk_mlx5_crypto_devs_get
		*
		* \param rdma_devs Array of device to be released
		*/
		void spdk_mlx5_crypto_devs_release(struct ibv_context **rdma_devs);

		/**
		* Create a keytag which contains DEKs per each crypto device in the system
		*
		* \param attr Crypto attributes
		* \param out Keytag
		* \return 0 on success, negated errno of failure
		*/
		int spdk_mlx5_crypto_keytag_create(struct spdk_mlx5_crypto_dek_create_attr *attr,
		struct spdk_mlx5_crypto_keytag **out);

		/**
		* Destroy a keytag created using \b spdk_mlx5_crypto_keytag_create
		*
		* \param keytag Keytag pointer
		*/
		void spdk_mlx5_crypto_keytag_destroy(struct spdk_mlx5_crypto_keytag *keytag);

		/**
		* Fills attributes used to register UMR with crypto operation
		*
		* \param attr_out Configured UMR attributes
		* \param keytag Keytag with DEKs
		* \param pd Protection Domain which is going to be used to register UMR. This function will find a DEK in \b keytag with the same PD
		* \param block_size Logical block size
		* \param iv Initialization vector or tweak. Usually that is logical block address
		* \param encrypt_on_tx If set, memory data will be encrypted during TX and wire data will be decrypted during RX. If not set, memory data will be decrypted during TX and wire data will be encrypted during RX.
		* \return 0 on success, negated errno on failure
		*/
		int spdk_mlx5_crypto_set_attr(struct mlx5dv_crypto_attr *attr_out,
		struct spdk_mlx5_crypto_keytag keytag, struct ibv_pd pd,
		uint32_t block_size, uint64_t iv, bool encrypt_on_tx);


		#endif /* SPDK_MLX5_H */

lib/Makefile

+3 −0

Original line number	Diff line number	Diff line
		@@ -22,6 +22,9 @@ DIRS-$(CONFIG_VBDEV_COMPRESS) += reduce
		DIRS-$(CONFIG_RDMA) += rdma
		DIRS-$(CONFIG_VFIO_USER) += vfu_tgt

		ifeq ($(CONFIG_RDMA_PROV),mlx5_dv)
		DIRS-y += mlx5
		endif
		# If CONFIG_ENV is pointing at a directory in lib, build it.
		# Out-of-tree env implementations must be built separately by the user.
		ENV_NAME := $(notdir $(CONFIG_ENV))

Admin message