ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

lib/blob: amend docs regarding io_units for spdk_blob_io_*()

Browse Source 
Some of the spdk_blob_io_*() still described pages as units
for submission instead of io_units.

No API change is occurring with this patch.

Change-Id: I6530db59de97a494ca7c5bf191e26d2a207c1159
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/463067
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Niu Yawei <yawei.niu@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Tomasz Zawadzki 2019-07-24 07:47:52 -04:00 committed by Ben Walker
parent b2caa1f0eb
commit 438d1beee7
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/spdk/blob.h
View File

@ -712,7 +712,7 @@ void spdk_blob_io_read(struct spdk_blob *blob, struct spdk_io_channel *channel,
spdk_blob_op_complete cb_fn, void *cb_arg);
/**
* Write the data described by 'iov' to 'length' pages beginning at 'offset' pages
* Write the data described by 'iov' to 'length' io_units beginning at 'offset' io_units
* into the blob.
*
* \param blob Blob to write.
@ -729,7 +729,7 @@ void spdk_blob_io_writev(struct spdk_blob *blob, struct spdk_io_channel *channel
spdk_blob_op_complete cb_fn, void *cb_arg);
/**
* Read 'length' pages starting at 'offset' pages into the blob into the memory
* Read 'length' io_units starting at 'offset' io_units into the blob into the memory
* described by 'iov'.
*
* \param blob Blob to read.
@ -746,13 +746,13 @@ void spdk_blob_io_readv(struct spdk_blob *blob, struct spdk_io_channel *channel,
spdk_blob_op_complete cb_fn, void *cb_arg);
/**
* Unmap 'length' pages beginning at 'offset' pages on the blob as unused. Unmapped
* pages may allow the underlying storage media to behave more effciently.
* Unmap 'length' io_units beginning at 'offset' io_units on the blob as unused. Unmapped
* io_units may allow the underlying storage media to behave more effciently.
*
* \param blob Blob to unmap.
* \param channel I/O channel used to submit requests.
* \param offset Offset is in io units from the beginning of the blob.
* \param length Size of unmap area in pages.
* \param length Size of unmap area in io_units.
* \param cb_fn Called when the operation is complete.
* \param cb_arg Argument passed to function cb_fn.
*/