Commit 58663640 authored by Konrad Sztyber's avatar Konrad Sztyber Committed by Jim Harris
Browse files

lib/bdev: separate metadata buffer IO functions 



This patch adds *_with_md family of functions allowing for IO with
metadata being transferred in a separate buffer.

Change-Id: I842d5a00a532cf5d0b0f0738535ea46903674140
Signed-off-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/451465


Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent 617a004f

include/spdk/bdev.h

+142 −0
Original line number Diff line number Diff line
@@ -436,6 +436,18 @@ uint32_t spdk_bdev_get_md_size(const struct spdk_bdev *bdev); 
 */

bool spdk_bdev_is_md_interleaved(const struct spdk_bdev *bdev);



/**

 * Query whether metadata is interleaved with block data or separated

 * from block data.

 *

 * \param bdev Block device to query.

 * \return true if metadata is separated from block data, false

 * otherwise.

 *

 * Note this function is valid only if there is metadata.

 */

bool spdk_bdev_is_md_separate(const struct spdk_bdev *bdev);



/**

 * Get block device data block size.

 *
@@ -620,6 +632,33 @@ int spdk_bdev_read_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *c 
			  void *buf, uint64_t offset_blocks, uint64_t num_blocks,

			  spdk_bdev_io_completion_cb cb, void *cb_arg);



/**

 * Submit a read request to the bdev on the given channel. This function uses

 * separate buffer for metadata transfer (valid only if bdev supports this

 * mode).

 *

 * \ingroup bdev_io_submit_functions

 *

 * \param desc Block device descriptor.

 * \param ch I/O channel. Obtained by calling spdk_bdev_get_io_channel().

 * \param buf Data buffer to read into.

 * \param md Metadata buffer.

 * \param offset_blocks The offset, in blocks, from the start of the block device.

 * \param num_blocks The number of blocks to read.

 * \param cb Called when the request is complete.

 * \param cb_arg Argument passed to cb.

 *

 * \return 0 on success. On success, the callback will always

 * be called (even if the request ultimately failed). Return

 * negated errno on failure, in which case the callback will not be called.

 *   * -EINVAL - offset_blocks and/or num_blocks are out of range or separate

 *               metadata is not supported

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 */

int spdk_bdev_read_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,

				  void *buf, void *md, int64_t offset_blocks, uint64_t num_blocks,

				  spdk_bdev_io_completion_cb cb, void *cb_arg);



/**

 * Submit a read request to the bdev on the given channel. This differs from

 * spdk_bdev_read by allowing the data buffer to be described in a scatter
@@ -678,6 +717,38 @@ int spdk_bdev_readv_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel * 
			   uint64_t offset_blocks, uint64_t num_blocks,

			   spdk_bdev_io_completion_cb cb, void *cb_arg);



/**

 * Submit a read request to the bdev on the given channel. This differs from

 * spdk_bdev_read by allowing the data buffer to be described in a scatter

 * gather list. Some physical devices place memory alignment requirements on

 * data or metadata and may not be able to directly transfer into the buffers

 * provided. In this case, the request may fail. This function uses separate

 * buffer for metadata transfer (valid only if bdev supports this mode).

 *

 * \ingroup bdev_io_submit_functions

 *

 * \param desc Block device descriptor.

 * \param ch I/O channel. Obtained by calling spdk_bdev_get_io_channel().

 * \param iov A scatter gather list of buffers to be read into.

 * \param iovcnt The number of elements in iov.

 * \param md Metadata buffer.

 * \param offset_blocks The offset, in blocks, from the start of the block device.

 * \param num_blocks The number of blocks to read.

 * \param cb Called when the request is complete.

 * \param cb_arg Argument passed to cb.

 *

 * \return 0 on success. On success, the callback will always

 * be called (even if the request ultimately failed). Return

 * negated errno on failure, in which case the callback will not be called.

 *   * -EINVAL - offset_blocks and/or num_blocks are out of range or separate

 *               metadata is not supported

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 */

int spdk_bdev_readv_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,

				   struct iovec *iov, int iovcnt, void *md,

				   uint64_t offset_blocks, uint64_t num_blocks,

				   spdk_bdev_io_completion_cb cb, void *cb_arg);



/**

 * Submit a write request to the bdev on the given channel.

 *
@@ -726,6 +797,34 @@ int spdk_bdev_write_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel * 
			   void *buf, uint64_t offset_blocks, uint64_t num_blocks,

			   spdk_bdev_io_completion_cb cb, void *cb_arg);



/**

 * Submit a write request to the bdev on the given channel. This function uses

 * separate buffer for metadata transfer (valid only if bdev supports this

 * mode).

 *

 * \ingroup bdev_io_submit_functions

 *

 * \param desc Block device descriptor.

 * \param ch I/O channel. Obtained by calling spdk_bdev_get_io_channel().

 * \param buf Data buffer to written from.

 * \param md Metadata buffer.

 * \param offset_blocks The offset, in blocks, from the start of the block device.

 * \param num_blocks The number of blocks to write. buf must be greater than or equal to this size.

 * \param cb Called when the request is complete.

 * \param cb_arg Argument passed to cb.

 *

 * \return 0 on success. On success, the callback will always

 * be called (even if the request ultimately failed). Return

 * negated errno on failure, in which case the callback will not be called.

 *   * -EINVAL - offset_blocks and/or num_blocks are out of range or separate

 *               metadata is not supported

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

int spdk_bdev_write_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,

				   void *buf, void *md, uint64_t offset_blocks, uint64_t num_blocks,

				   spdk_bdev_io_completion_cb cb, void *cb_arg);



/**

 * Submit a write request to the bdev on the given channel. This differs from

 * spdk_bdev_write by allowing the data buffer to be described in a scatter
@@ -786,6 +885,39 @@ int spdk_bdev_writev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel 
			    uint64_t offset_blocks, uint64_t num_blocks,

			    spdk_bdev_io_completion_cb cb, void *cb_arg);



/**

 * Submit a write request to the bdev on the given channel. This differs from

 * spdk_bdev_write by allowing the data buffer to be described in a scatter

 * gather list. Some physical devices place memory alignment requirements on

 * data or metadata and may not be able to directly transfer out of the buffers

 * provided. In this case, the request may fail.  This function uses separate

 * buffer for metadata transfer (valid only if bdev supports this mode).

 *

 * \ingroup bdev_io_submit_functions

 *

 * \param desc Block device descriptor.

 * \param ch I/O channel. Obtained by calling spdk_bdev_get_io_channel().

 * \param iov A scatter gather list of buffers to be written from.

 * \param iovcnt The number of elements in iov.

 * \param md Metadata buffer.

 * \param offset_blocks The offset, in blocks, from the start of the block device.

 * \param num_blocks The number of blocks to write.

 * \param cb Called when the request is complete.

 * \param cb_arg Argument passed to cb.

 *

 * \return 0 on success. On success, the callback will always

 * be called (even if the request ultimately failed). Return

 * negated errno on failure, in which case the callback will not be called.

 *   * -EINVAL - offset_blocks and/or num_blocks are out of range or separate

 *               metadata is not supported

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

int spdk_bdev_writev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,

				    struct iovec *iov, int iovcnt, void *md,

				    uint64_t offset_blocks, uint64_t num_blocks,

				    spdk_bdev_io_completion_cb cb, void *cb_arg);



/**

 * Submit a request to acquire a data buffer that represents the given

 * range of blocks. The data buffer is placed in the spdk_bdev_io structure
@@ -1197,6 +1329,16 @@ void spdk_bdev_io_get_scsi_status(const struct spdk_bdev_io *bdev_io, 
 */

void spdk_bdev_io_get_iovec(struct spdk_bdev_io *bdev_io, struct iovec **iovp, int *iovcntp);



/**

 * Get metadata buffer. Only makes sense if the IO uses separate buffer for

 * metadata transfer.

 *

 * \param bdev_io I/O to retrieve the buffer from.

 * \return Pointer to metadata buffer, NULL if the IO doesn't use separate

 * buffer for metadata transfer.

 */

void *spdk_bdev_io_get_md_buf(struct spdk_bdev_io *bdev_io);



typedef void (*spdk_bdev_histogram_status_cb)(void *cb_arg, int status);

typedef void (*spdk_bdev_histogram_data_cb)(void *cb_arg, int status,

		struct spdk_histogram_data *histogram);

include/spdk/bdev_module.h

+13 −0
Original line number Diff line number Diff line
@@ -436,6 +436,9 @@ struct spdk_bdev_io { 
			/** For SG buffer cases, number of iovecs in iovec array. */

			int iovcnt;



			/* Metadata buffer */

			void *md_buf;



			/** Total size of data to be transferred. */

			uint64_t num_blocks;
@@ -556,6 +559,7 @@ struct spdk_bdev_io { 
		struct iovec  bounce_iov;

		struct iovec *orig_iovs;

		int           orig_iovcnt;

		void	     *orig_md_buf;



		/** Callback for when buf is allocated */

		spdk_bdev_io_get_buf_cb get_buf_cb;
@@ -756,6 +760,15 @@ void spdk_bdev_io_get_buf(struct spdk_bdev_io *bdev_io, spdk_bdev_io_get_buf_cb 
 */

void spdk_bdev_io_set_buf(struct spdk_bdev_io *bdev_io, void *buf, size_t len);



/**

 * Set the given buffer as metadata buffer described by this bdev_io.

 *

 * \param bdev_io I/O to set the buffer on.

 * \param md_buf The buffer to set as the active metadata buffer.

 * \param len The length of the metadata buffer.

 */

void spdk_bdev_io_set_md_buf(struct spdk_bdev_io *bdev_io, void *md_buf, size_t len);



/**

 * Complete a bdev_io

 *

lib/bdev/bdev.c

+290 −62

File changed.

Preview size limit exceeded, changes collapsed.