From 685f31d60654a7b07898e7692db1f4d9d8fb3e6c Mon Sep 17 00:00:00 2001 From: Monica Kenguva Date: Tue, 21 Jul 2020 02:07:58 +0000 Subject: [PATCH] doc: uring bdev userguide update Signed-off-by: Monica Kenguva Change-Id: Ic365b52d1eb978a0a4c400484bca49f61e4a2708 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3466 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins Reviewed-by: Tomasz Zawadzki Reviewed-by: Shuhei Matsumoto Reviewed-by: Ben Walker --- doc/bdev.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/bdev.md b/doc/bdev.md index a232c745b..3383777e3 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -512,6 +512,23 @@ To remove a block device representation use the bdev_pmem_delete command. `rpc.py bdev_pmem_delete pmem` +# Uring {#bdev_ug_uring} + +The uring bdev module issues I/O to kernel block devices using the io_uring Linux kernel API. This module requires liburing. +For more information on io_uring refer to kernel [IO_uring] (https://kernel.dk/io_uring.pdf) + +The user needs to configure SPDK to include io_uring support: + +`configure --with-uring` + +To create a uring bdev with given filename, bdev name and block size use the `bdev_uring_create` RPC. + +`rpc.py bdev_uring_create /path/to/device bdev_u0 512` + +To remove a uring bdev use the `bdev_uring_delete` RPC. + +`rpc.py bdev_uring_delete bdev_u0` + # Virtio Block {#bdev_config_virtio_blk} The Virtio-Block driver allows creating SPDK bdevs from Virtio-Block devices.