docs: add 'io_uring' option to 'aio' param in qemu-options.hx

[PATCH] docs: add 'io_uring' option to 'aio' param in qemu-options.hx

Posted by Stefano Garzarella 3 years, 7 months ago

When we added io_uring AIO engine, we forgot to update qemu-options.hx,
so qemu(1) man page and qemu help were outdated.

Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
---
 qemu-options.hx | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 47f64be0c0..5b098577fe 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1053,7 +1053,8 @@ SRST
             The path to the image file in the local filesystem
 
         ``aio``
-            Specifies the AIO backend (threads/native, default: threads)
+            Specifies the AIO backend (threads/native/io_uring,
+            default: threads)
 
         ``locking``
             Specifies whether the image file is protected with Linux OFD
@@ -1175,7 +1176,8 @@ DEF("drive", HAS_ARG, QEMU_OPTION_drive,
     "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
     "       [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
     "       [,snapshot=on|off][,rerror=ignore|stop|report]\n"
-    "       [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n"
+    "       [,werror=ignore|stop|report|enospc][,id=name]\n"
+    "       [,aio=threads|native|io_uring]\n"
     "       [,readonly=on|off][,copy-on-read=on|off]\n"
     "       [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
     "       [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
@@ -1247,8 +1249,8 @@ SRST
         The default mode is ``cache=writeback``.
 
     ``aio=aio``
-        aio is "threads", or "native" and selects between pthread based
-        disk I/O and native Linux AIO.
+        aio is "threads", "native", or "io_uring" and selects between pthread
+        based disk I/O, native Linux AIO, or Linux io_uring API.
 
     ``format=format``
         Specify which disk format will be used rather than detecting the
-- 
2.26.2

Re: [PATCH] docs: add 'io_uring' option to 'aio' param in qemu-options.hx

Posted by Julia Suvorova 3 years, 7 months ago

On Thu, Sep 24, 2020 at 5:15 PM Stefano Garzarella <sgarzare@redhat.com> wrote:
>
> When we added io_uring AIO engine, we forgot to update qemu-options.hx,
> so qemu(1) man page and qemu help were outdated.
>
> Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>

Reviewed-by: Julia Suvorova <jusual@redhat.com>

> ---
>  qemu-options.hx | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 47f64be0c0..5b098577fe 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -1053,7 +1053,8 @@ SRST
>              The path to the image file in the local filesystem
>
>          ``aio``
> -            Specifies the AIO backend (threads/native, default: threads)
> +            Specifies the AIO backend (threads/native/io_uring,
> +            default: threads)
>
>          ``locking``
>              Specifies whether the image file is protected with Linux OFD
> @@ -1175,7 +1176,8 @@ DEF("drive", HAS_ARG, QEMU_OPTION_drive,
>      "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
>      "       [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
>      "       [,snapshot=on|off][,rerror=ignore|stop|report]\n"
> -    "       [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n"
> +    "       [,werror=ignore|stop|report|enospc][,id=name]\n"
> +    "       [,aio=threads|native|io_uring]\n"
>      "       [,readonly=on|off][,copy-on-read=on|off]\n"
>      "       [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
>      "       [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
> @@ -1247,8 +1249,8 @@ SRST
>          The default mode is ``cache=writeback``.
>
>      ``aio=aio``
> -        aio is "threads", or "native" and selects between pthread based
> -        disk I/O and native Linux AIO.
> +        aio is "threads", "native", or "io_uring" and selects between pthread
> +        based disk I/O, native Linux AIO, or Linux io_uring API.
>
>      ``format=format``
>          Specify which disk format will be used rather than detecting the
> --
> 2.26.2
>

Re: [PATCH] docs: add 'io_uring' option to 'aio' param in qemu-options.hx

Posted by Pankaj Gupta 3 years, 7 months ago

> When we added io_uring AIO engine, we forgot to update qemu-options.hx,
> so qemu(1) man page and qemu help were outdated.
>
> Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
> ---
>  qemu-options.hx | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 47f64be0c0..5b098577fe 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -1053,7 +1053,8 @@ SRST
>              The path to the image file in the local filesystem
>
>          ``aio``
> -            Specifies the AIO backend (threads/native, default: threads)
> +            Specifies the AIO backend (threads/native/io_uring,
> +            default: threads)
>
>          ``locking``
>              Specifies whether the image file is protected with Linux OFD
> @@ -1175,7 +1176,8 @@ DEF("drive", HAS_ARG, QEMU_OPTION_drive,
>      "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
>      "
>  [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
>      "       [,snapshot=on|off][,rerror=ignore|stop|report]\n"
> -    "
>  [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n"
> +    "       [,werror=ignore|stop|report|enospc][,id=name]\n"
> +    "       [,aio=threads|native|io_uring]\n"
>      "       [,readonly=on|off][,copy-on-read=on|off]\n"
>      "       [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
>      "       [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
> @@ -1247,8 +1249,8 @@ SRST
>          The default mode is ``cache=writeback``.
>
>      ``aio=aio``
> -        aio is "threads", or "native" and selects between pthread based
> -        disk I/O and native Linux AIO.
> +        aio is "threads", "native", or "io_uring" and selects between
> pthread
> +        based disk I/O, native Linux AIO, or Linux io_uring API.
>
>      ``format=format``
>          Specify which disk format will be used rather than detecting the
>

Reviewed-by: Pankaj Gupta <pankaj.gupta.linux@gmail.com>

-- 
> 2.26.2
>
>
>

Re: [PATCH] docs: add 'io_uring' option to 'aio' param in qemu-options.hx

Posted by Stefan Hajnoczi 3 years, 7 months ago

On Thu, Sep 24, 2020 at 05:15:11PM +0200, Stefano Garzarella wrote:
> When we added io_uring AIO engine, we forgot to update qemu-options.hx,
> so qemu(1) man page and qemu help were outdated.
> 
> Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
> ---
>  qemu-options.hx | 10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)

Thanks, applied to my block-next tree:
https://github.com/stefanha/qemu/commits/block-next

Stefan