Commit 7409664c authored by Jim Harris's avatar Jim Harris
Browse files

bdev: clarify errnos that spdk_bdev I/O routines can return 



Signed-off-by: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: I59229c5499f50a2522a93832c22756156ec1a1a8

Reviewed-on: https://review.gerrithub.io/414893


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent 7fe28556

include/spdk/bdev.h

+45 −0
Original line number Diff line number Diff line
@@ -403,6 +403,8 @@ struct spdk_io_channel *spdk_bdev_get_io_channel(struct spdk_bdev_desc *desc); 
 * \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 and/or nbytes are not aligned or out of range

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 */

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

		   void *buf, uint64_t offset, uint64_t nbytes,
@@ -422,6 +424,8 @@ int spdk_bdev_read(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 
 * \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

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 */

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

			  void *buf, uint64_t offset_blocks, uint64_t num_blocks,
@@ -446,6 +450,8 @@ int spdk_bdev_read_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *c 
 * \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 and/or nbytes are not aligned or out of range

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 */

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

		    struct iovec *iov, int iovcnt,
@@ -471,6 +477,8 @@ int spdk_bdev_readv(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 
 * \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

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 */

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

			   struct iovec *iov, int iovcnt,
@@ -491,6 +499,9 @@ int spdk_bdev_readv_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel * 
 * \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 and/or nbytes are not aligned or out of range

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

		    void *buf, uint64_t offset, uint64_t nbytes,
@@ -510,6 +521,9 @@ int spdk_bdev_write(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 
 * \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

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

			   void *buf, uint64_t offset_blocks, uint64_t num_blocks,
@@ -534,6 +548,9 @@ int spdk_bdev_write_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel * 
 * \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 and/or nbytes are not aligned or out of range

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

		     struct iovec *iov, int iovcnt,
@@ -559,6 +576,9 @@ int spdk_bdev_writev(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 
 * \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

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

			    struct iovec *iov, int iovcnt,
@@ -579,6 +599,9 @@ int spdk_bdev_writev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel 
 * \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 and/or nbytes are not aligned or out of range

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

			   uint64_t offset, uint64_t len,
@@ -598,6 +621,9 @@ int spdk_bdev_write_zeroes(struct spdk_bdev_desc *desc, struct spdk_io_channel * 
 * \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

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

				  uint64_t offset_blocks, uint64_t num_blocks,
@@ -618,6 +644,9 @@ int spdk_bdev_write_zeroes_blocks(struct spdk_bdev_desc *desc, struct spdk_io_ch 
 * \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 and/or nbytes are not aligned or out of range

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

		    uint64_t offset, uint64_t nbytes,
@@ -638,6 +667,9 @@ int spdk_bdev_unmap(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 
 * \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

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

			   uint64_t offset_blocks, uint64_t num_blocks,
@@ -658,6 +690,9 @@ int spdk_bdev_unmap_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel * 
 * \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 and/or nbytes are not aligned or out of range

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

		    uint64_t offset, uint64_t length,
@@ -678,6 +713,9 @@ int spdk_bdev_flush(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 
 * \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

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

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

			   uint64_t offset_blocks, uint64_t num_blocks,
@@ -694,6 +732,7 @@ int spdk_bdev_flush_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel * 
 * \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.

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 */

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

		    spdk_bdev_io_completion_cb cb, void *cb_arg);
@@ -728,6 +767,8 @@ void spdk_bdev_set_qos_limit_iops(struct spdk_bdev *bdev, uint64_t ios_per_sec, 
 * \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.

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

int spdk_bdev_nvme_admin_passthru(struct spdk_bdev_desc *desc,

				  struct spdk_io_channel *ch,
@@ -755,6 +796,8 @@ int spdk_bdev_nvme_admin_passthru(struct spdk_bdev_desc *desc, 
 * \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.

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

int spdk_bdev_nvme_io_passthru(struct spdk_bdev_desc *bdev_desc,

			       struct spdk_io_channel *ch,
@@ -784,6 +827,8 @@ int spdk_bdev_nvme_io_passthru(struct spdk_bdev_desc *bdev_desc, 
 * \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.

 *   * -ENOMEM - spdk_bdev_io buffer cannot be allocated

 *   * -EBADF - desc not open for writing

 */

int spdk_bdev_nvme_io_passthru_md(struct spdk_bdev_desc *bdev_desc,

				  struct spdk_io_channel *ch,