Commit 076ae917 authored by Karl Bonde Torp's avatar Karl Bonde Torp Committed by Tomasz Zawadzki
Browse files

doc/bdev: update docs for bdev_xnvme 

This includes:
- changing "xnvme" to "xNVMe"
- replacing the dead link to https://xnvme.io/docs/latest


- listing the most important I/O mechanisms

Change-Id: I3f628ac0ca6f24cc7251ed62b771f9e02a1bd34a
Signed-off-by: default avatarKarl Bonde Torp <k.torp@samsung.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24090


Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent 968224f4

doc/bdev.md

+11 −5
Original line number Diff line number Diff line
@@ -596,22 +596,28 @@ To remove a uring bdev use the `bdev_uring_delete` RPC. 


`rpc.py bdev_uring_delete bdev_u0`



## xnvme {#bdev_ug_xnvme}

## xNVMe {#bdev_ug_xnvme}



The xnvme bdev module issues I/O to the underlying NVMe devices through various I/O mechanisms

The xNVMe bdev module issues I/O to the underlying NVMe devices through various I/O mechanisms

such as libaio, io_uring, Asynchronous IOCTL using io_uring passthrough, POSIX aio, emulated aio etc.



This module requires xNVMe library.

For more information on xNVMe refer to [xNVMe] (https://xnvme.io/docs/latest)

This module requires the xNVMe library.

For more information on xNVMe refer to [xNVMe] (https://xnvme.io)



The user needs to configure SPDK to include xNVMe support:



`configure --with-xnvme`



To create a xnvme bdev with given filename, bdev name and I/O mechanism use the `bdev_xnvme_create` RPC.

To create a xNVMe bdev with given filename, bdev name and I/O mechanism use the `bdev_xnvme_create` RPC.



`rpc.py  bdev_xnvme_create /dev/ng0n1 bdev_ng0n1 io_uring_cmd`



The most important I/O mechanisms are:



- "libaio"

- "io_uring"

- "io_uring_cmd" (requires linux kernel v5.19 or newer)



To remove a xnvme bdev use the `bdev_xnvme_delete` RPC.



`rpc.py bdev_xnvme_delete bdev_ng0n1`