Skip to contentSkip to conversation

docs: add qemu-storage-daemon documentation

PATCH Superseded Stefan Hajnoczi 3 participants 10 messages Sep 10, 2020 – Dec 9, 2020 Arm/Amlogic Meson SoC support

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover docs: add qemu-storage-daemon documentation

v2:
* Drop block-core.json h2 header removal, add an h1 header to storage-daemon/qapi/qapi-schema.json instead [Kevin]
* Add Examples section to man page [Kevin]

Add documentation for the qemu-storage-daemon program and its QMP commands.

The man page looks like this:

QEMU-STORAGE-DAEMON(1) QEMU QEMU-STORAGE-DAEMON(1)

NAME
qemu-storage-daemon - QEMU storage daemon

SYNOPSIS
qemu-storage-daemon [options]

DESCRIPTION
qemu-storage-daemon provides disk image functionality from QEMU, qemu-img, and qemu-nbd in a long-running process controlled via QMP commands without running a virtual machine. It can export disk images over NBD, run block job operations, and perform other disk-related operations. The daemon is controlled via a QMP monitor socket and initial configuration from the command-line.

The daemon offers the following subset of QEMU features:
· Blockdev nodes
· Block jobs
· NBD server
· Character devices
· Crypto and secrets
· QMP

Commands can be sent over a QEMU Monitor Protocol (QMP) connection. See the qemu-storage-daemon-qmp-ref(7) manual page for a description of the commands.

The daemon runs until it is stopped using the quit QMP command or SIGINT/SIGHUP/SIGTERM.

Warning: Never modify images in use by a running virtual machine or any other process; this may destroy the image. Also, be aware that querying an image that is being modified by another process may encounter inconsistent state.

OPTIONS
Standard options:

-h, --help
Display this help and exit

-V, --version
Display version information and exit

-T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]
Specify tracing options.

[enable=]PATTERN
Immediately enable events matching PATTERN (either event name or a globbing pattern). This option is only available if QEMU has been compiled with the simple, log or ftrace tracing backend. To specify multiple events or patterns, specify the -trace option multiple times.

Use -trace help to print a list of names of trace points.

events=FILE
Immediately enable events listed in FILE. The file must contain one event name (as listed in the trace-events-all file) per line; globbing patterns are accepted too. This option is only available if QEMU has been compiled with the simple, log or ftrace tracing backend.

file=FILE
Log output traces to FILE. This option is only available if QEMU has been compiled with the simple tracing backend.

--blockdev BLOCKDEVDEF
is a blockdev node definition. See the qemu(1) manual page for a description of blockdev node properties and the qemu-block-drivers(7) manual page for a description of driver-specific parameters.

--chardev CHARDEVDEF
is a character device definition. See the qemu(1) manual page for a description of character device properties. A common character device definition configures a UNIX domain socket:

--chardev socket,id=char1,path=/tmp/qmp.sock,server,nowait

--monitor MONITORDEF
is a QMP monitor definition. See the qemu(1) manual page for a description of QMP monitor properties. A common QMP monitor definition configures a monitor on character device char1:

--monitor chardev=char1

--nbd-server addr.type=inet,addr.host=<host>,addr.port=<port>[,tls-creds=<id>][,tls-authz=<id>]

--nbd-server addr.type=unix,addr.path=<path>[,tls-creds=<id>][,tls-authz=<id>]
is a NBD server definition. Both TCP and UNIX domain sockets are supported. TLS encryption can be configured using --object tls-creds-* and authz-* secrets (see below).

To configure an NBD server on UNIX domain socket path /tmp/nbd.sock:

--nbd-server addr.type=unix,addr.path=/tmp/nbd.sock

--object help

--object <type>,help

--object <type>[,<property>=<value>...]
is a QEMU user creatable object definition. List object types with help. List object properties with <type>,help. See the qemu(1) manual page for a description of the object properties. The most common object type is a secret, which is used to supply passwords and/or encryption keys.

EXAMPLES

       Launch the daemon with QMP monitor socket qmp.sock so clients can
       execute QMP commands:

          $ qemu-storage-daemon \
              --chardev socket,path=qmp.sock,server,nowait,id=char1 \
              --monitor chardev=char1

       Export raw image file disk.img over NBD UNIX domain socket nbd.sock:

          $ qemu-storage-daemon \
              --blockdev driver=file,node-name=disk,filename=disk.img \
              --nbd-server addr.type=unix,addr.path=nbd.sock \
              --export type=nbd,device=disk,writable=on

SEE ALSO

       qemu(1), qemu-block-drivers(7), qemu-storage-daemon-qmp-ref(7)

COPYRIGHT
2020, The QEMU Project Developers

5.1.50 Sep 10, 2020 QEMU-STORAGE-DAEMON(1)

Stefan Hajnoczi (3):
docs: generate qemu-storage-daemon-qmp-ref(7) man page
docs: add qemu-storage-daemon(1) man page
MAINTAINERS: add Kevin Wolf as storage daemon maintainer

 MAINTAINERS                                   |   9 ++
 storage-daemon/qapi/qapi-schema.json          |   4 +
 docs/interop/qemu-storage-daemon-qmp-ref.texi |  80 ++++++++++++
 docs/tools/conf.py                            |   2 +
 docs/tools/index.rst                          |   1 +
 docs/tools/qemu-storage-daemon.rst            | 121 ++++++++++++++++++
 meson.build                                   |   9 ++
 storage-daemon/qapi/meson.build               |   2 +
 8 files changed, 228 insertions(+)
 create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.texi
 create mode 100644 docs/tools/qemu-storage-daemon.rst
Signature · 1 line
2.26.2
#1 lore raw

PATCH v2 1/3 docs: generate qemu-storage-daemon-qmp-ref(7) man page

Although qemu-storage-daemon QMP commands are identical to QEMU QMP commands they are a subset. Generate a manual page of just the commands supported by qemu-storage-daemon so that users know exactly what is available in qemu-storage-daemon.

Add an h1 heading in storage-daemon/qapi/qapi-schema.json so that block-core.json is at the h2 heading level.

---
 storage-daemon/qapi/qapi-schema.json          |  4 +
 docs/interop/qemu-storage-daemon-qmp-ref.texi | 80 +++++++++++++++++++
 meson.build                                   |  9 +++
 storage-daemon/qapi/meson.build               |  2 +
 4 files changed, 95 insertions(+)
 create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.texi
storage-daemon/qapi/qapi-schema.json +4 -0
index 6100d1f0c9..939a6afd18 100644
@@ -15,7 +15,11 @@
 
 { 'include': '../../qapi/pragma.json' }
 
+##
+# = Block devices
+##
 { 'include': '../../qapi/block-core.json' }
+
 { 'include': '../../qapi/char.json' }
 { 'include': '../../qapi/common.json' }
 { 'include': '../../qapi/control.json' }
docs/interop/qemu-storage-daemon-qmp-ref.texi new file +80 -0

80 lines not on this page · raw message

meson.build +9 -0
index 5421eca66a..f20e409f8e 100644
@@ -1229,6 +1229,15 @@ if build_docs
   if 'CONFIG_GUEST_AGENT' in config_host
     texi += {'qemu-ga-ref': ['docs/interop/qemu-ga-ref.texi', qga_qapi_doc_texi, version_texi]}
   endif
+  if have_tools
+    texi += {
+      'qemu-storage-daemon-qmp-ref': [
+	'docs/interop/qemu-storage-daemon-qmp-ref.texi',
+	qsd_qapi_doc_texi,
+	version_texi
+      ]
+    }
+  endif
 
   if makeinfo.found()
     cmd = [
storage-daemon/qapi/meson.build +2 -0
index cea618bec0..7c48a388d4 100644
@@ -4,4 +4,6 @@ qsd_qapi_files = custom_target('QAPI files for qemu-storage-daemon',
                                command: [ qapi_gen, '-o', 'storage-daemon/qapi', '@INPUT@' ],
                                depend_files: [ qapi_inputs, qapi_gen_depends ])
 
+qsd_qapi_doc_texi = qsd_qapi_files[-1]
+
 qsd_ss.add(qsd_qapi_files.to_list())
Signature · 1 line
2.26.2
#2 lore raw

Re: [PATCH v2 1/3] docs: generate qemu-storage-daemon-qmp-ref(7) man page

Am 10.09.2020 um 16:43 hat Stefan Hajnoczi geschrieben:

Quoted 9 lines

Although qemu-storage-daemon QMP commands are identical to QEMU QMP commands they are a subset. Generate a manual page of just the commands supported by qemu-storage-daemon so that users know exactly what is available in qemu-storage-daemon.

Add an h1 heading in storage-daemon/qapi/qapi-schema.json so that block-core.json is at the h2 heading level.

As the series doesn't apply any more, I can't actually try it out easily, but is the order of includes in the schema right now?

I seem to remember that in v1 we discussed that nested includes result in an unexpected section structure in the documentation in some cases (such as generic jobs being documented in a subsection of block devices), and that we need to reorder includes in qapi-schema.json to fix this because a more clever doc generator wasn't considered worth the effort.

Kevin

#3 lore raw

Re: [PATCH v2 1/3] docs: generate qemu-storage-daemon-qmp-ref(7) man page

Quoted 14 lines · Kevin Wolf

Am 10.09.2020 um 16:43 hat Stefan Hajnoczi geschrieben:

Quoted 9 lines

Although qemu-storage-daemon QMP commands are identical to QEMU QMP commands they are a subset. Generate a manual page of just the commands supported by qemu-storage-daemon so that users know exactly what is available in qemu-storage-daemon.

Add an h1 heading in storage-daemon/qapi/qapi-schema.json so that block-core.json is at the h2 heading level.

As the series doesn't apply any more, I can't actually try it out easily, but is the order of includes in the schema right now?

Quoted 6 lines

I seem to remember that in v1 we discussed that nested includes result in an unexpected section structure in the documentation in some cases (such as generic jobs being documented in a subsection of block devices), and that we need to reorder includes in qapi-schema.json to fix this because a more clever doc generator wasn't considered worth the effort.

v2 onwards takes a different approach and leaves the header where it is.

Stefan

#4 lore raw

PATCH v2 2/3 docs: add qemu-storage-daemon(1) man page

In reply to Stefan Hajnoczi

Document the qemu-storage-daemon tool. Most of the command-line options are identical to their QEMU counterparts. Perhaps Sphinx hxtool integration could be extended to extract documentation for individual command-line options so they can be shared. For now the qemu-storage-daemon simply refers to the qemu(1) man page where the command-line options are identical.

---
 docs/tools/conf.py                 |   2 +
 docs/tools/index.rst               |   1 +
 docs/tools/qemu-storage-daemon.rst | 121 +++++++++++++++++++++++++++++
 3 files changed, 124 insertions(+)
 create mode 100644 docs/tools/qemu-storage-daemon.rst
docs/tools/conf.py +2 -0
index 9052d17d6d..c16290e716 100644
@@ -20,6 +20,8 @@ html_theme_options['description'] = \
 man_pages = [
     ('qemu-img', 'qemu-img', u'QEMU disk image utility',
      ['Fabrice Bellard'], 1),
+    ('qemu-storage-daemon', 'qemu-storage-daemon', u'QEMU storage daemon',
+     [], 1),
     ('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server',
      ['Anthony Liguori <[email protected]>'], 8),
     ('qemu-trace-stap', 'qemu-trace-stap', u'QEMU SystemTap trace tool',
docs/tools/index.rst +1 -0
index 232ce9f3e4..9b076adb62 100644
@@ -11,6 +11,7 @@ Contents:
    :maxdepth: 2
 
    qemu-img
+   qemu-storage-daemon
    qemu-nbd
    qemu-trace-stap
    virtfs-proxy-helper
docs/tools/qemu-storage-daemon.rst new file +121 -0

121 lines not on this page · raw message

Signature · 1 line
2.26.2
#5 lore raw

Re: [PATCH v2 2/3] docs: add qemu-storage-daemon(1) man page

Am 10.09.2020 um 16:43 hat Stefan Hajnoczi geschrieben:

Quoted 50 lines

Document the qemu-storage-daemon tool. Most of the command-line options are identical to their QEMU counterparts. Perhaps Sphinx hxtool integration could be extended to extract documentation for individual command-line options so they can be shared. For now the qemu-storage-daemon simply refers to the qemu(1) man page where the command-line options are identical.

---
 docs/tools/conf.py                 |   2 +
 docs/tools/index.rst               |   1 +
 docs/tools/qemu-storage-daemon.rst | 121 +++++++++++++++++++++++++++++
 3 files changed, 124 insertions(+)
 create mode 100644 docs/tools/qemu-storage-daemon.rst
docs/tools/conf.py +2 -0
index 9052d17d6d..c16290e716 100644
@@ -20,6 +20,8 @@ html_theme_options['description'] = \
 man_pages = [
     ('qemu-img', 'qemu-img', u'QEMU disk image utility',
      ['Fabrice Bellard'], 1),
+    ('qemu-storage-daemon', 'qemu-storage-daemon', u'QEMU storage daemon',
+     [], 1),
     ('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server',
      ['Anthony Liguori <[email protected]>'], 8),
 
docs/tools/index.rst +1 -0
index 232ce9f3e4..9b076adb62 100644
@@ -11,6 +11,7 @@ Contents:
    :maxdepth: 2
 
    qemu-img
+   qemu-storage-daemon
    qemu-nbd
    qemu-trace-stap
    virtfs-proxy-helper
docs/tools/qemu-storage-daemon.rst new file +4 -0
new file mode 100644
index 0000000000..a0b8b1a2bf
@@ -0,0 +1,121 @@
+QEMU Storage Daemon
+===================
+
+Synopsis

docs/tools/qemu-storage-daemon.rst line 14

Quoted 10 lines
docs/tools/qemu-storage-daemon.rst new file +10 -0
+--------
+
+**qemu-storage-daemon** [options]
+
+Description
+-----------
+
+qemu-storage-daemon provides disk image functionality from QEMU, qemu-img, and
+qemu-nbd in a long-running process controlled via QMP commands without running
+a virtual machine. It can export disk images over NBD, run block job

While this is true today, I think we should phrase it in a more generic way so that we don't have to modify it each time we add something.

Specifically, I wouldn't mention NBD here, but just say "can export disk images". If you want, you can add something like "(e.g. over NBD)" to make clear that this won't be the only option.

docs/tools/qemu-storage-daemon.rst line 16

Quoted 2 lines
docs/tools/qemu-storage-daemon.rst new file +2 -0
+operations, and perform other disk-related operations. The daemon is controlled
+via a QMP monitor socket and initial configuration from the command-line.

Likewise I would s/socket// because you can have the QMP monitor on any chardev. It could be a socket, it could be stdio, maybe there is even a third option that makes sense.

docs/tools/qemu-storage-daemon.rst line 20

Quoted 3 lines
docs/tools/qemu-storage-daemon.rst new file +3 -0
+The daemon offers the following subset of QEMU features:
+
+* Blockdev nodes

I think we call this "Block nodes" usually in documentation.

docs/tools/qemu-storage-daemon.rst line 22

Quoted 2 lines
docs/tools/qemu-storage-daemon.rst new file +2 -0
+* Block jobs
+* NBD server

Let's make this "Block exports"

docs/tools/qemu-storage-daemon.rst line 25

Quoted 3 lines
docs/tools/qemu-storage-daemon.rst new file +3 -0
+* Character devices
+* Crypto and secrets
+* QMP

If we mention crypto/secrets, should we also mention iothreads explicitly? Or throttle groups?

Or again more generically something like "User-creatable QOM objects such as crypto secrets and iothread"?

Quoted 12 lines
docs/tools/qemu-storage-daemon.rst new file +12 -0
+Commands can be sent over a QEMU Monitor Protocol (QMP) connection. See the
+:manpage:`qemu-storage-daemon-qmp-ref(7)` manual page for a description of the
+commands.
+
+The daemon runs until it is stopped using the ``quit`` QMP command or
+SIGINT/SIGHUP/SIGTERM.
+
+**Warning:** Never modify images in use by a running virtual machine or any
+other process; this may destroy the image. Also, be aware that querying an
+image that is being modified by another process may encounter inconsistent
+state.
+

docs/tools/qemu-storage-daemon.rst line 48

Quoted 10 lines
docs/tools/qemu-storage-daemon.rst new file +10 -0
+Options
+-------
+
+.. program:: qemu-storage-daemon
+
+Standard options:
+
+.. option:: -h, --help
+
+  Display this help and exit

It's not "this" help in the man page.

Quoted 4 lines
docs/tools/qemu-storage-daemon.rst new file +4 -0
+.. option:: -V, --version
+
+  Display version information and exit
+

docs/tools/qemu-storage-daemon.rst line 63

Quoted 10 lines
docs/tools/qemu-storage-daemon.rst new file +10 -0
+.. option:: -T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]
+
+  .. include:: ../qemu-option-trace.rst.inc
+
+.. option:: --blockdev BLOCKDEVDEF
+
+  is a blockdev node definition. See the :manpage:`qemu(1)` manual page for a
+  description of blockdev node properties and the
+  :manpage:`qemu-block-drivers(7)` manual page for a description of
+  driver-specific parameters.

s/blockdev/block/g

qemu-block-drivers(7) was originally a list of options for 'qemu-img create'. I see that it now describes runtime options for some drivers (in particular the network drivers), but not the image format drivers.

I guess this needs some cleanup so that create options and runtime options are clearly separated, and that runtime options for format drivers are documented.

It doesn't have to stop this patch, though the reference could be confusing when the other man page starts with create options.

Quoted 26 lines
docs/tools/qemu-storage-daemon.rst new file +26 -0
+.. option:: --chardev CHARDEVDEF
+
+  is a character device definition. See the :manpage:`qemu(1)` manual page for
+  a description of character device properties. A common character device
+  definition configures a UNIX domain socket::
+
+  --chardev socket,id=char1,path=/tmp/qmp.sock,server,nowait
+
+.. option:: --monitor MONITORDEF
+
+  is a QMP monitor definition. See the :manpage:`qemu(1)` manual page for
+  a description of QMP monitor properties. A common QMP monitor definition
+  configures a monitor on character device ``char1``::
+
+  --monitor chardev=char1
+
+.. option:: --nbd-server addr.type=inet,addr.host=<host>,addr.port=<port>[,tls-creds=<id>][,tls-authz=<id>]
+  --nbd-server addr.type=unix,addr.path=<path>[,tls-creds=<id>][,tls-authz=<id>]
+
+  is a NBD server definition. Both TCP and UNIX domain sockets are supported.
+  TLS encryption can be configured using ``--object`` tls-creds-* and authz-*
+  secrets (see below).
+
+  To configure an NBD server on UNIX domain socket path ``/tmp/nbd.sock``::
+
+  --nbd-server addr.type=unix,addr.path=/tmp/nbd.sock

docs/tools/qemu-storage-daemon.rst line 100

Quoted 10 lines
docs/tools/qemu-storage-daemon.rst new file +10 -0
+
+.. option:: --object help
+  --object <type>,help
+  --object <type>[,<property>=<value>...]
+
+  is a QEMU user creatable object definition. List object types with ``help``.
+  List object properties with ``<type>,help``. See the :manpage:`qemu(1)`
+  manual page for a description of the object properties. The most common
+  object type is a ``secret``, which is used to supply passwords and/or
+  encryption keys.

Isn't iothread more common actually?

Quoted 5 lines
docs/tools/qemu-storage-daemon.rst new file +5 -0
+Examples
+--------
+Launch the daemon with QMP monitor socket ``qmp.sock`` so clients can execute
+QMP commands::
+

docs/tools/qemu-storage-daemon.rst line 116

Quoted 10 lines
docs/tools/qemu-storage-daemon.rst new file +10 -0
+  $ qemu-storage-daemon \
+      --chardev socket,path=qmp.sock,server,nowait,id=char1 \
+      --monitor chardev=char1
+
+Export raw image file ``disk.img`` over NBD UNIX domain socket ``nbd.sock``::
+
+  $ qemu-storage-daemon \
+      --blockdev driver=file,node-name=disk,filename=disk.img \
+      --nbd-server addr.type=unix,addr.path=nbd.sock \
+      --export type=nbd,device=disk,writable=on

The --export syntax for NBD has changed with the block export series. I think that you need s/device/node-name/ and that it requires an id=... option now, too.

Quoted 6 lines
docs/tools/qemu-storage-daemon.rst new file +4 -0
+See also
+--------
+
+:manpage:`qemu(1)`, :manpage:`qemu-block-drivers(7)`, :manpage:`qemu-storage-daemon-qmp-ref(7)`
Signature · 1 line
2.26.2

Kevin

#6 lore raw

PATCH v2 3/3 MAINTAINERS: add Kevin Wolf as storage daemon maintainer

In reply to Stefan Hajnoczi

The MAINTAINERS file was not updated when the storage daemon was merged.

---
 MAINTAINERS | 9 +++++++++
 1 file changed, 9 insertions(+)
MAINTAINERS +9 -0
index 7d0a5e91e4..eb80b6c548 100644
@@ -2099,6 +2099,15 @@ F: qobject/block-qdict.c
 F: tests/check-block-qdict.c
 T: git https://repo.or.cz/qemu/kevin.git block
 
+Storage daemon
+M: Kevin Wolf <[email protected]>
+L: [email protected]
+S: Supported
+F: storage-daemon/
+F: docs/interop/qemu-storage-daemon-qmp-ref.texi
+F: docs/tools/qemu-storage-daemon.rst
+T: git https://repo.or.cz/qemu/kevin.git block
+
 Block I/O path
 M: Stefan Hajnoczi <[email protected]>
 M: Fam Zheng <[email protected]>
Signature · 1 line
2.26.2
Reviewed-by on v2 3/3
#8 lore raw

Re: [PATCH v2 3/3] MAINTAINERS: add Kevin Wolf as storage daemon maintainer

In reply to Stefan Hajnoczi
Quoted 18 lines · Stefan Hajnoczi

The MAINTAINERS file was not updated when the storage daemon was merged.

---
 MAINTAINERS | 9 +++++++++
 1 file changed, 9 insertions(+)
MAINTAINERS +2 -0
index 7d0a5e91e4..eb80b6c548 100644
@@ -2099,6 +2099,15 @@ F: qobject/block-qdict.c
 F: tests/check-block-qdict.c
 T: git https://repo.or.cz/qemu/kevin.git block
 
+Storage daemon
+M: Kevin Wolf <[email protected]>

MAINTAINERS F: qobject/block-qdict.c · line 2113

Quoted 10 lines
MAINTAINERS +7 -0
+L: [email protected]
+S: Supported
+F: storage-daemon/
+F: docs/interop/qemu-storage-daemon-qmp-ref.texi
+F: docs/tools/qemu-storage-daemon.rst
+T: git https://repo.or.cz/qemu/kevin.git block
+
 Block I/O path
 M: Stefan Hajnoczi <[email protected]>
 M: Fam Zheng <[email protected]>

=)

#9 lore raw
In reply to Stefan Hajnoczi
Quoted 4 lines · Stefan Hajnoczi

v2:
* Drop block-core.json h2 header removal, add an h1 header to storage-daemon/qapi/qapi-schema.json instead [Kevin]
* Add Examples section to man page [Kevin]

Ping

Quoted 141 lines

Add documentation for the qemu-storage-daemon program and its QMP commands.

The man page looks like this:

QEMU-STORAGE-DAEMON(1) QEMU QEMU-STORAGE-DAEMON(1)

NAME
qemu-storage-daemon - QEMU storage daemon

SYNOPSIS
qemu-storage-daemon [options]

DESCRIPTION
qemu-storage-daemon provides disk image functionality from QEMU, qemu-img, and qemu-nbd in a long-running process controlled via QMP commands without running a virtual machine. It can export disk images over NBD, run block job operations, and perform other disk-related operations. The daemon is controlled via a QMP monitor socket and initial configuration from the command-line.

The daemon offers the following subset of QEMU features:
· Blockdev nodes
· Block jobs
· NBD server
· Character devices
· Crypto and secrets
· QMP

Commands can be sent over a QEMU Monitor Protocol (QMP) connection. See the qemu-storage-daemon-qmp-ref(7) manual page for a description of the commands.

The daemon runs until it is stopped using the quit QMP command or SIGINT/SIGHUP/SIGTERM.

Warning: Never modify images in use by a running virtual machine or any other process; this may destroy the image. Also, be aware that querying an image that is being modified by another process may encounter inconsistent state.

OPTIONS
Standard options:

-h, --help
Display this help and exit

-V, --version
Display version information and exit

-T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]
Specify tracing options.

[enable=]PATTERN
Immediately enable events matching PATTERN (either event name or a globbing pattern). This option is only available if QEMU has been compiled with the simple, log or ftrace tracing backend. To specify multiple events or patterns, specify the -trace option multiple times.

Use -trace help to print a list of names of trace points.

events=FILE
Immediately enable events listed in FILE. The file must contain one event name (as listed in the trace-events-all file) per line; globbing patterns are accepted too. This option is only available if QEMU has been compiled with the simple, log or ftrace tracing backend.

file=FILE
Log output traces to FILE. This option is only available if QEMU has been compiled with the simple tracing backend.

--blockdev BLOCKDEVDEF
is a blockdev node definition. See the qemu(1) manual page for a description of blockdev node properties and the qemu-block-drivers(7) manual page for a description of driver-specific parameters.

--chardev CHARDEVDEF
is a character device definition. See the qemu(1) manual page for a description of character device properties. A common character device definition configures a UNIX domain socket:

--chardev socket,id=char1,path=/tmp/qmp.sock,server,nowait

--monitor MONITORDEF
is a QMP monitor definition. See the qemu(1) manual page for a description of QMP monitor properties. A common QMP monitor definition configures a monitor on character device char1:

--monitor chardev=char1

--nbd-server addr.type=inet,addr.host=<host>,addr.port=<port>[,tls-creds=<id>][,tls-authz=<id>]

--nbd-server addr.type=unix,addr.path=<path>[,tls-creds=<id>][,tls-authz=<id>]
is a NBD server definition. Both TCP and UNIX domain sockets are supported. TLS encryption can be configured using --object tls-creds-* and authz-* secrets (see below).

To configure an NBD server on UNIX domain socket path /tmp/nbd.sock:

--nbd-server addr.type=unix,addr.path=/tmp/nbd.sock

--object help

--object <type>,help

--object <type>[,<property>=<value>...]
is a QEMU user creatable object definition. List object types with help. List object properties with <type>,help. See the qemu(1) manual page for a description of the object properties. The most common object type is a secret, which is used to supply passwords and/or encryption keys.

EXAMPLES

       Launch the daemon with QMP monitor socket qmp.sock so clients can
       execute QMP commands:

          $ qemu-storage-daemon \
              --chardev socket,path=qmp.sock,server,nowait,id=char1 \
              --monitor chardev=char1

       Export raw image file disk.img over NBD UNIX domain socket nbd.sock:

          $ qemu-storage-daemon \
              --blockdev driver=file,node-name=disk,filename=disk.img \
              --nbd-server addr.type=unix,addr.path=nbd.sock \
              --export type=nbd,device=disk,writable=on

SEE ALSO

       qemu(1), qemu-block-drivers(7), qemu-storage-daemon-qmp-ref(7)

COPYRIGHT
2020, The QEMU Project Developers

5.1.50 Sep 10, 2020 QEMU-STORAGE-DAEMON(1)

Stefan Hajnoczi (3):
docs: generate qemu-storage-daemon-qmp-ref(7) man page
docs: add qemu-storage-daemon(1) man page
MAINTAINERS: add Kevin Wolf as storage daemon maintainer

 MAINTAINERS                                   |   9 ++
 storage-daemon/qapi/qapi-schema.json          |   4 +
 docs/interop/qemu-storage-daemon-qmp-ref.texi |  80 ++++++++++++
 docs/tools/conf.py                            |   2 +
 docs/tools/index.rst                          |   1 +
 docs/tools/qemu-storage-daemon.rst            | 121 ++++++++++++++++++
 meson.build                                   |   9 ++
 storage-daemon/qapi/meson.build               |   2 +
 8 files changed, 228 insertions(+)
 create mode 100644 docs/interop/qemu-storage-daemon-qmp-ref.texi
 create mode 100644 docs/tools/qemu-storage-daemon.rst
Signature · 1 line
2.26.2