Spdk/lib/nvme/nvme_cuse.h

/*   SPDX-License-Identifier: BSD-3-Clause
 *   Copyright (c) Intel Corporation.
 *   All rights reserved.
 */

#ifndef __NVME_CUSE_H__
#define __NVME_CUSE_H__

#include "spdk/nvme.h"

int nvme_cuse_register(struct spdk_nvme_ctrlr *ctrlr, const char *dev_path);
void nvme_cuse_unregister(struct spdk_nvme_ctrlr *ctrlr);

#endif /* __NVME_CUSE_H__ */
Replace most BSD 3-clause license text with SPDX identifier. Many open source projects have moved to using SPDX identifiers to specify license information, reducing the amount of boilerplate code in every source file. This patch replaces the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause identifier. Almost all of these files share the exact same license text, and this patch only modifies the files that contain the most common license text. There can be slight variations because the third clause contains company names - most say "Intel Corporation", but there are instances for Nvidia, Samsung, Eideticom and even "the copyright holder". Used a bash script to automate replacement of the license text with SPDX identifier which is checked into scripts/spdx.sh. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Dong Yi <dongx.yi@intel.com> Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: <qun.wan@intel.com> 2022-06-03 19:15:11 +00:00			`/* SPDX-License-Identifier: BSD-3-Clause`
lib/nvme: add NVMe character device NVMe character device implementation. This patch adds implementation of IO producer using CUSE library. It allows to create nvme device nodes in linux kernel for controller as well as for namespace and process ioctl requests as usual from linux environment. Both devices (controller and namespaces) are exposed as character devices. To compile NVMe CUSE module use "./configure --with-nvme-cuse". Names for created CUSE devices can be retrieved using spdk_nvme_cuse_get_ctrlr_name() and spdk_nvme_cuse_get_ns_name(). Signed-off-by: Jim Harris <james.r.harris@intel.com> Signed-off-by: Tomasz Kulasek <tomaszx.kulasek@intel.com> Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Signed-off-by: Maciej Szwed <maciej.szwed@intel.com> Change-Id: I0fc9a9a1ef3c9c2b3112d07c2b4b1f8d49665ee1 Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466917 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> 2019-10-24 18:04:33 +00:00			`* Copyright (c) Intel Corporation.`
			`* All rights reserved.`
			`*/`

			`#ifndef __NVME_CUSE_H__`
			`#define __NVME_CUSE_H__`

			`#include "spdk/nvme.h"`

lib/nvme: add RPC for interacting with CUSE devices Added RPC commands to register/unregister CUSE devices to NVMe controllers: - bdev_nvme_cuse_register - bdev_nvme_cuse_unregister Additionally two RPC now return CUSE device names: - bdev_get_bdevs for namespaces - bdev_nvme_get_controllers for controllers Signed-off-by: Maciej Szwed <maciej.szwed@intel.com> Change-Id: I69c4bf41ec8f78a7522894268a67dd733881712f Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Signed-off-by: Tomasz Kulasek <tomaszx.kulasek@intel.com> Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/472211 Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> 2019-10-24 18:09:47 +00:00			`int nvme_cuse_register(struct spdk_nvme_ctrlr ctrlr, const char dev_path);`
lib/nvme: add NVMe character device NVMe character device implementation. This patch adds implementation of IO producer using CUSE library. It allows to create nvme device nodes in linux kernel for controller as well as for namespace and process ioctl requests as usual from linux environment. Both devices (controller and namespaces) are exposed as character devices. To compile NVMe CUSE module use "./configure --with-nvme-cuse". Names for created CUSE devices can be retrieved using spdk_nvme_cuse_get_ctrlr_name() and spdk_nvme_cuse_get_ns_name(). Signed-off-by: Jim Harris <james.r.harris@intel.com> Signed-off-by: Tomasz Kulasek <tomaszx.kulasek@intel.com> Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Signed-off-by: Maciej Szwed <maciej.szwed@intel.com> Change-Id: I0fc9a9a1ef3c9c2b3112d07c2b4b1f8d49665ee1 Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/466917 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> 2019-10-24 18:04:33 +00:00			`void nvme_cuse_unregister(struct spdk_nvme_ctrlr *ctrlr);`

			`#endif /* __NVME_CUSE_H__ */`