Commit 6b528ed2 authored by Konrad Sztyber's avatar Konrad Sztyber
Browse files

bdev: update comments on spdk_bdev_ext_io_opts usage 



The comments were updated to reflect that this structure no longer needs
to be valid until an IO is completed - this was changed in 55f94793.
Also, added an entry to the changelog describing this change, as it
might affect out-of-tree bdev modules.

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


Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 140eb8a6

CHANGELOG.md

+3 −0
Original line number Diff line number Diff line
@@ -17,6 +17,9 @@ New APIs `spdk_bdev_quiesce`, `spdk_bdev_unquiesce`, `spdk_bdev_quiesce_range` a 
`spdk_bdev_unquiesce_range` were added. These allow I/O to be quiesced on an entire bdev or

a specified LBA range.



Removed `spdk_bdev_ext_io_opts` from `spdk_bdev_io` and replaced it with fields that were missing in

`spdk_bdev_io`.



### env



New functions `spdk_env_get_main_core` and `spdk_env_get_cpuset` were added.

include/spdk/bdev.h

+4 −6
Original line number Diff line number Diff line
@@ -1039,9 +1039,8 @@ int spdk_bdev_readv_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_c 
 * \param num_blocks The number of blocks to read.

 * \param cb Called when the request is complete.

 * \param cb_arg Argument passed to cb.

 * \param opts Optional structure with extended IO request options. If set, this structure must be

 * valid until the IO is completed. `size` member of this structure is used for ABI compatibility and

 * must be set to sizeof(struct spdk_bdev_ext_io_opts).

 * \param opts Optional structure with extended IO request options. `size` member of this structure

 *             is used for ABI compatibility and must be set to sizeof(struct spdk_bdev_ext_io_opts).

 *

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

 * be called (even if the request ultimately failed). Return
@@ -1242,9 +1241,8 @@ int spdk_bdev_writev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_ 
 * \param num_blocks The number of blocks to write.

 * \param cb Called when the request is complete.

 * \param cb_arg Argument passed to cb.

 * \param opts Optional structure with extended IO request options. If set, this structure must be

 * valid until the IO is completed. `size` member of this structure is used for ABI compatibility and

 * must be set to sizeof(struct spdk_bdev_ext_io_opts).

 * \param opts Optional structure with extended IO request options. `size` member of this structure

 *             is used for ABI compatibility and must be set to sizeof(struct spdk_bdev_ext_io_opts).

 *

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

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