f4fd07c68c
VFIO is a framework that allows a physical device to be securely passed through
to a user space process. Typically, the user space process is a VM and the device
is passed through to it in order to achieve high performance. VFIO provides an API
and the required functionality in the kernel.
vfio-user is a framework that allows implementing PCI devices in userspace.
SPDK NVMf library provides the emulation of a NVMe device, combined with vfio-user
protocol, we can provide the emulated NVMe device to VM or client application, such
as SPDK NVMe perf.
This patch has dependency on libvfio-user library, users can start NVMe identify/perf
examples.
Usage:
1. Start nvmf_target.
2. Use RPC to create a subsystem with namespace bdev.
mkdir -p /var/run/muser
mkdir -p /var/run/muser/iommu_group
mkdir -p /var/run/muser/domain/muser0/8
mkdir -p /dev/shm/muser/muser0
scripts/rpc.py nvmf_create_transport -t VFIOUSER
scripts/rpc.py nvmf_create_subsystem -a nqn.2019-07.io.spdk.muser:/var/run/muser/domain/muser0/8
scripts/rpc.py bdev_malloc_create -b muser0 $((512)) 512
scripts/rpc.py nvmf_subsystem_add_ns -n 1 nqn.2019-07.io.spdk.muser:/var/run/muser/domain/muser0/8 muser0
scripts/rpc.py nvmf_subsystem_add_listener -t VFIOUSER -a "/var/run/muser/domain/muser0/8" -s 0 nqn.2019-07.io.spdk.muser:/var/run/muser/domain/muser0/8
ln -s /var/run/muser/domain/muser0/8 /var/run/muser/domain/muser0/8/iommu_group
ln -s /var/run/muser/domain/muser0/8 /var/run/muser/iommu_group/8
ln -s /var/run/muser/domain/muser0/8/bar0 /dev/shm/muser/muser0/bar0
Currently, file /var/run/muser/domain/muser0/8/ctrlr is the socket file which is used
to transfer socket messages between target and client.
[1] https://www.mail-archive.com/qemu-devel@nongnu.org/msg723794.html
Co-authored-by: Ben Walker <benjamin.walker@intel.com>
Co-authored-by: Changpeng Liu <changpeng.liu@intel.com>
Co-authored-by: Thanos Makatos <thanos.makatos@nutanix.com>
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Signed-off-by: Changpeng Liu <changpeng.liu@intel.com>
Change-Id: I5f2a8e77314a6a13aa6366dd4a6dc77b13434e7b
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3838
Community-CI: Broadcom CI
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
83 lines
2.8 KiB
Makefile
83 lines
2.8 KiB
Makefile
#
|
|
# BSD LICENSE
|
|
#
|
|
# Copyright (c) Intel Corporation.
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions
|
|
# are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright
|
|
# notice, this list of conditions and the following disclaimer in
|
|
# the documentation and/or other materials provided with the
|
|
# distribution.
|
|
# * Neither the name of Intel Corporation nor the names of its
|
|
# contributors may be used to endorse or promote products derived
|
|
# from this software without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
#
|
|
|
|
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..)
|
|
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
|
|
|
|
SO_VER := 7
|
|
SO_MINOR := 0
|
|
|
|
C_SRCS = ctrlr.c ctrlr_discovery.c ctrlr_bdev.c \
|
|
subsystem.c nvmf.c nvmf_rpc.c transport.c tcp.c
|
|
|
|
C_SRCS-$(CONFIG_RDMA) += rdma.c
|
|
LIBNAME = nvmf
|
|
LOCAL_SYS_LIBS =
|
|
ifeq ($(CONFIG_RDMA),y)
|
|
LOCAL_SYS_LIBS += -libverbs -lrdmacm
|
|
#Attach only if FreeBSD and RDMA is specified with configure
|
|
ifeq ($(OS),FreeBSD)
|
|
# Mellanox - MLX4 HBA Userspace Library
|
|
ifneq ("$(wildcard /usr/lib/libmlx4.*)","")
|
|
LOCAL_SYS_LIBS += -lmlx4
|
|
endif
|
|
# Mellanox - MLX5 HBA Userspace Library
|
|
ifneq ("$(wildcard /usr/lib/libmlx5.*)","")
|
|
LOCAL_SYS_LIBS += -lmlx5
|
|
endif
|
|
# Chelsio HBA Userspace Library
|
|
ifneq ("$(wildcard /usr/lib/libcxgb4.*)","")
|
|
LOCAL_SYS_LIBS += -lcxgb4
|
|
endif
|
|
endif
|
|
endif
|
|
|
|
ifeq ($(CONFIG_VFIO_USER), y)
|
|
C_SRCS += vfio_user.c
|
|
CFLAGS += -I$(VFIO_USER_INCLUDE_DIR)
|
|
LDFLAGS += -L$(VFIO_USER_LIBRARY_DIR)
|
|
LOCAL_SYS_LIBS += -Wl,-Bstatic -lvfio-user -Wl,-Bdynamic -ljson-c
|
|
endif
|
|
|
|
ifeq ($(CONFIG_FC),y)
|
|
C_SRCS += fc.c fc_ls.c
|
|
CFLAGS += -I$(CURDIR) $(ENV_CFLAGS)
|
|
ifneq ($(strip $(CONFIG_FC_PATH)),)
|
|
CFLAGS += -I$(CONFIG_FC_PATH)
|
|
endif
|
|
endif
|
|
|
|
SPDK_MAP_FILE = $(abspath $(CURDIR)/spdk_nvmf.map)
|
|
|
|
include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk
|