diff mbox series

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

Message ID 20200924151511.131471-1-sgarzare@redhat.com
State New
Headers show
Series docs: add 'io_uring' option to 'aio' param in qemu-options.hx | expand

Commit Message

Stefano Garzarella Sept. 24, 2020, 3:15 p.m. UTC
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(-)

Comments

Julia Suvorova Sept. 24, 2020, 3:57 p.m. UTC | #1
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

>
Pankaj Gupta Sept. 24, 2020, 5:28 p.m. UTC | #2
> 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

>

>

>
<div dir="auto"><div><div class="gmail_quote"><div dir="ltr" class="gmail_attr"><br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">When we added io_uring AIO engine, we forgot to update qemu-options.hx,<br>
so qemu(1) man page and qemu help were outdated.<br>
<br>
Signed-off-by: Stefano Garzarella &lt;<a href="mailto:sgarzare@redhat.com" target="_blank" rel="noreferrer">sgarzare@redhat.com</a>&gt;<br>

---<br>
 qemu-options.hx | 10 ++++++----<br>
 1 file changed, 6 insertions(+), 4 deletions(-)<br>
<br>
diff --git a/qemu-options.hx b/qemu-options.hx<br>
index 47f64be0c0..5b098577fe 100644<br>
--- a/qemu-options.hx<br>
+++ b/qemu-options.hx<br>
@@ -1053,7 +1053,8 @@ SRST<br>
             The path to the image file in the local filesystem<br>
<br>
         ``aio``<br>
-            Specifies the AIO backend (threads/native, default: threads)<br>
+            Specifies the AIO backend (threads/native/io_uring,<br>
+            default: threads)<br>
<br>
         ``locking``<br>
             Specifies whether the image file is protected with Linux OFD<br>
@@ -1175,7 +1176,8 @@ DEF(&quot;drive&quot;, HAS_ARG, QEMU_OPTION_drive,<br>
     &quot;-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n&quot;<br>
     &quot;       [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n&quot;<br>
     &quot;       [,snapshot=on|off][,rerror=ignore|stop|report]\n&quot;<br>
-    &quot;       [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n&quot;<br>
+    &quot;       [,werror=ignore|stop|report|enospc][,id=name]\n&quot;<br>
+    &quot;       [,aio=threads|native|io_uring]\n&quot;<br>
     &quot;       [,readonly=on|off][,copy-on-read=on|off]\n&quot;<br>
     &quot;       [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n&quot;<br>
     &quot;       [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n&quot;<br>
@@ -1247,8 +1249,8 @@ SRST<br>
         The default mode is ``cache=writeback``.<br>
<br>
     ``aio=aio``<br>
-        aio is &quot;threads&quot;, or &quot;native&quot; and selects between pthread based<br>
-        disk I/O and native Linux AIO.<br>
+        aio is &quot;threads&quot;, &quot;native&quot;, or &quot;io_uring&quot; and selects between pthread<br>
+        based disk I/O, native Linux AIO, or Linux io_uring API.<br>
<br>
     ``format=format``<br>
         Specify which disk format will be used rather than detecting the<br></blockquote></div></div><div dir="auto"><br></div><div dir="auto"><pre style="font-family:&quot;courier new&quot;,courier,monospace;font-size:16px;font-weight:600">Reviewed-by: Pankaj Gupta &lt;<a href="mailto:pankaj.gupta.linux@gmail.com">pankaj.gupta.linux@gmail.com</a>&gt;</pre></div><div dir="auto"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
-- <br>
2.26.2<br>
<br>
<br>
</blockquote></div></div></div>
Stefan Hajnoczi Sept. 25, 2020, 8:38 a.m. UTC | #3
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
diff mbox series

Patch

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