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

doc/bdev_module: clarify claim v2 types

Browse Source 
This gets documentation in sync with the latest updates to bdev claims.

Signed-off-by: Mike Gerdts <mgerdts@nvidia.com>
Change-Id: Id59cbf6ecd4c4b3ebeb4d053e430b2bc68c87d60
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16741
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
This commit is contained in:
Mike Gerdts 2023-02-08 20:51:38 -06:00 committed by Tomasz Zawadzki
parent 5d989b1edf
commit 58c75caaaa
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/bdev_module.md
View File

@ -162,12 +162,12 @@ reading from or writing to the underlying bdev.
There are two slightly different APIs for taking and releasing claims. The There are two slightly different APIs for taking and releasing claims. The
preferred interface uses `spdk_bdev_module_claim_bdev_desc()`. This method allows preferred interface uses `spdk_bdev_module_claim_bdev_desc()`. This method allows
claims that ensure there is a single writer with claims that ensure there is a single writer with
`SPDK_BDEV_CLAIM_READ_WRITE_ONCE`, cooperating shared writers with `SPDK_BDEV_CLAIM_READ_MANY_WRITE_ONE`, cooperating shared writers with
`SPDK_BDEV_CLAIM_READ_WRITE_MANY`, and shared readers that prevent any `SPDK_BDEV_CLAIM_READ_MANY_WRITE_SHARED`, and shared readers that prevent any
writers with `SPDK_BDEV_CLAIM_READ_ONLY_MANY`. In all cases, writers with `SPDK_BDEV_CLAIM_READ_MANY_WRITE_NONE`. In all cases,
`spdk_bdev_open_ext()` may be used to open the underlying bdev read-only. If a `spdk_bdev_open_ext()` may be used to open the underlying bdev read-only. If a
read-only bdev descriptor successfully claims a bdev with read-only bdev descriptor successfully claims a bdev with
`SPDK_BDEV_CLAIM_READ_WRITE_ONCE` or `SPDK_BDEV_CLAIM_READ_WRITE_MANY` `SPDK_BDEV_CLAIM_READ_MANY_WRITE_ONE` or `SPDK_BDEV_CLAIM_READ_MANY_WRITE_SHARED`
the bdev descriptor is promoted to read-write. the bdev descriptor is promoted to read-write.
Any claim that is obtained with `spdk_bdev_module_claim_bdev_desc()` is Any claim that is obtained with `spdk_bdev_module_claim_bdev_desc()` is
automatically released upon closing the bdev descriptor used to obtain the automatically released upon closing the bdev descriptor used to obtain the