8b260d5c92
Example usage using `bdevperf` as the client:
Start `spdk_tgt` with created virtio_scsi device:
1. scripts/rpc.py bdev_malloc_create -b malloc0 $((512)) 512
2. scripts/rpc.py vfu_virtio_create_scsi_endpoint vfu.0 --cpumask 0x1 --num-io-queues=4 \
--qsize=128 --packed-ring
3. scripts/rpc.py vfu_virtio_scsi_add_target vfu.0 --scsi-target-num=0 --bdev-name malloc0
Start `bdevperf`:
1. test/bdev/bdevperf/bdevperf -r /var/tmp/spdk.sock.1 -g -s 2048 -q 128 -o 4096 \
-w randread -t 30 -m 0x2
2. scripts/rpc.py -s /var/tmp/spdk.sock.1 bdev_virtio_attach_controller --dev-type scsi \
--trtype vfio-user --traddr vfu.0 VirtioScsi0
3. test/bdev/bdevperf/bdevperf.py -s /var/tmp/spdk.sock.1 perform_tests
Change-Id: Id95908a5243e9a224a9bd709a22b87740c50b835
Signed-off-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/13897
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
179 lines
7.3 KiB
C
179 lines
7.3 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (c) Intel Corporation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
#ifndef SPDK_BDEV_VIRTIO_H
|
|
#define SPDK_BDEV_VIRTIO_H
|
|
|
|
#include "spdk/bdev.h"
|
|
#include "spdk/env.h"
|
|
|
|
/**
|
|
* Callback for creating virtio bdevs.
|
|
*
|
|
* \param ctx opaque context set by the user
|
|
* \param errnum error code. 0 on success, negative errno on error.
|
|
* \param bdevs contiguous array of created bdevs
|
|
* \param bdev_cnt number of bdevs in the `bdevs` array
|
|
*/
|
|
typedef void (*bdev_virtio_create_cb)(void *ctx, int errnum,
|
|
struct spdk_bdev **bdevs, size_t bdev_cnt);
|
|
|
|
/**
|
|
* Callback for removing virtio devices.
|
|
*
|
|
* \param ctx opaque context set by the user
|
|
* \param errnum error code. 0 on success, negative errno on error.
|
|
*/
|
|
typedef void (*bdev_virtio_remove_cb)(void *ctx, int errnum);
|
|
|
|
/**
|
|
* Connect to a vhost-user Unix domain socket and create a Virtio SCSI device.
|
|
* If the connection is successful, the device will be automatically scanned.
|
|
* The scan consists of probing the targets on the device and will result in
|
|
* creating possibly multiple Virtio SCSI bdevs - one for each target. Currently
|
|
* only one LUN per target is detected - LUN0. Note that the bdev creation is
|
|
* run asynchronously in the background. After it's finished, the `cb_fn`
|
|
* callback is called.
|
|
*
|
|
* \param name name for the virtio device. It will be inherited by all created
|
|
* bdevs, which are named in the following format: <name>t<target_id>
|
|
* \param path path to the socket
|
|
* \param num_queues max number of request virtqueues to use. `vdev` will be
|
|
* started successfully even if the host device supports less queues than requested.
|
|
* \param queue_size depth of each queue
|
|
* \param cb_fn function to be called after scanning all targets on the virtio
|
|
* device. It's optional, can be NULL. See \c bdev_virtio_create_cb.
|
|
* \param cb_arg argument for the `cb_fn`
|
|
* \return zero on success (device scan is started) or negative error code.
|
|
* In case of error the \c cb_fn is not called.
|
|
*/
|
|
int bdev_virtio_user_scsi_dev_create(const char *name, const char *path,
|
|
unsigned num_queues, unsigned queue_size,
|
|
bdev_virtio_create_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Connect to a vfio-user Unix domain socket and create a Virtio SCSI device.
|
|
* If the connection is successful, the device will be automatically scanned.
|
|
* The scan consists of probing the targets on the device and will result in
|
|
* creating possibly multiple Virtio SCSI bdevs - one for each target. Currently
|
|
* only one LUN per target is detected - LUN0. Note that the bdev creation is
|
|
* run asynchronously in the background. After it's finished, the `cb_fn`
|
|
* callback is called.
|
|
*
|
|
* \param name name for the virtio device. It will be inherited by all created
|
|
* bdevs, which are named in the following format: <name>t<target_id>
|
|
* \param path path to the socket
|
|
* \param cb_fn function to be called after scanning all targets on the virtio
|
|
* device. It's optional, can be NULL. See \c bdev_virtio_create_cb.
|
|
* \param cb_arg argument for the `cb_fn`
|
|
* \return zero on success (device scan is started) or negative error code.
|
|
* In case of error the \c cb_fn is not called.
|
|
*/
|
|
int bdev_vfio_user_scsi_dev_create(const char *base_name, const char *path,
|
|
bdev_virtio_create_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Attach virtio-pci device. This creates a Virtio SCSI device with the same
|
|
* capabilities as the vhost-user equivalent. The device will be automatically
|
|
* scanned for exposed SCSI targets. This will result in creating possibly multiple
|
|
* Virtio SCSI bdevs - one for each target. Currently only one LUN per target is
|
|
* detected - LUN0. Note that the bdev creation is run asynchronously in the
|
|
* background. After it's finished, the `cb_fn` callback is called.
|
|
*
|
|
* \param name name for the virtio device. It will be inherited by all created
|
|
* bdevs, which are named in the following format: <name>t<target_id>
|
|
* \param pci_addr PCI address of the device to attach
|
|
* \param cb_fn function to be called after scanning all targets on the virtio
|
|
* device. It's optional, can be NULL. See \c bdev_virtio_create_cb.
|
|
* \param cb_arg argument for the `cb_fn`
|
|
* \return zero on success (device scan is started) or negative error code.
|
|
* In case of error the \c cb_fn is not called.
|
|
*/
|
|
int bdev_virtio_pci_scsi_dev_create(const char *name, struct spdk_pci_addr *pci_addr,
|
|
bdev_virtio_create_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Remove a Virtio device with given name. This will destroy all bdevs exposed
|
|
* by this device.
|
|
*
|
|
* \param name virtio device name
|
|
* \param cb_fn function to be called after scanning all targets on the virtio
|
|
* device. It's optional, can be NULL. See \c bdev_virtio_create_cb. Possible
|
|
* error codes are:
|
|
* * ENODEV - couldn't find device with given name
|
|
* * EBUSY - device is already being removed
|
|
* \param cb_arg argument for the `cb_fn`
|
|
* \return zero on success or -ENODEV if scsi dev does not exist
|
|
*/
|
|
int bdev_virtio_scsi_dev_remove(const char *name,
|
|
bdev_virtio_remove_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Remove a Virtio device with given name.
|
|
*
|
|
* \param bdev virtio blk device bdev
|
|
* \param cb_fn function to be called after removing bdev
|
|
* \param cb_arg argument for the `cb_fn`
|
|
* \return zero on success, -ENODEV if bdev with 'name' does not exist or
|
|
* -EINVAL if bdev with 'name' is not a virtio blk device.
|
|
*/
|
|
int bdev_virtio_blk_dev_remove(const char *name,
|
|
bdev_virtio_remove_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* List all created Virtio-SCSI devices.
|
|
*
|
|
* \param write_ctx JSON context to write into
|
|
*/
|
|
void bdev_virtio_scsi_dev_list(struct spdk_json_write_ctx *write_ctx);
|
|
|
|
/**
|
|
* Connect to a vhost-user Unix domain socket and create a Virtio BLK bdev.
|
|
*
|
|
* \param name name for the virtio bdev
|
|
* \param path path to the socket
|
|
* \param num_queues max number of request virtqueues to use. `vdev` will be
|
|
* started successfully even if the host device supports less queues than requested.
|
|
* \param queue_size depth of each queue
|
|
* \return virtio-blk bdev or NULL
|
|
*/
|
|
struct spdk_bdev *bdev_virtio_user_blk_dev_create(const char *name, const char *path,
|
|
unsigned num_queues, unsigned queue_size);
|
|
|
|
/**
|
|
* Connect to a vfio-user Unix domain socket and create a Virtio BLK bdev.
|
|
*
|
|
* \param name name for the virtio bdev
|
|
* \param path path to the socket
|
|
* \return virtio-blk bdev or NULL
|
|
*/
|
|
struct spdk_bdev *
|
|
bdev_virtio_vfio_user_blk_dev_create(const char *name, const char *path);
|
|
|
|
/**
|
|
* Attach virtio-pci device. This creates a Virtio BLK device with the same
|
|
* capabilities as the vhost-user equivalent.
|
|
*
|
|
* \param name name for the virtio device. It will be inherited by all created
|
|
* bdevs, which are named in the following format: <name>t<target_id>
|
|
* \param pci_addr PCI address of the device to attach
|
|
* \return virtio-blk bdev or NULL
|
|
*/
|
|
struct spdk_bdev *bdev_virtio_pci_blk_dev_create(const char *name,
|
|
struct spdk_pci_addr *pci_addr);
|
|
|
|
/**
|
|
* Enable/Disable the virtio blk hotplug monitor or
|
|
* change the monitor period time
|
|
*
|
|
* \param enabled True means to enable the hotplug monitor and the monitor
|
|
* period time is period_us. False means to disable the hotplug monitor
|
|
* \param period_us The period time of the hotplug monitor in us
|
|
* \return 0 for success otherwise failure
|
|
*/
|
|
int bdev_virtio_pci_blk_set_hotplug(bool enabled, uint64_t period_us);
|
|
|
|
#endif /* SPDK_BDEV_VIRTIO_H */
|