2020-09-24 23:26:48 +08:00
|
|
|
# -*- Mode: Python -*-
|
|
|
|
# vim: filetype=python
|
|
|
|
|
|
|
|
##
|
|
|
|
# == Block device exports
|
|
|
|
##
|
|
|
|
|
|
|
|
{ 'include': 'sockets.json' }
|
qapi: nbd-export: allow select bitmaps by node/name pair
Hi all! Current logic of relying on search through backing chain is not
safe neither convenient.
Sometimes it leads to necessity of extra bitmap copying. Also, we are
going to add "snapshot-access" driver, to access some snapshot state
through NBD. And this driver is not formally a filter, and of course
it's not a COW format driver. So, searching through backing chain will
not work. Instead of widening the workaround of bitmap searching, let's
extend the interface so that user can select bitmap precisely.
Note, that checking for bitmap active status is not copied to the new
API, I don't see a reason for it, user should understand the risks. And
anyway, bitmap from other node is unrelated to this export being
read-only or read-write.
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@openvz.org>
Message-Id: <20220314213226.362217-3-v.sementsov-og@mail.ru>
[eblake: Adjust S-o-b to Vladimir's new email, with permission]
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2022-03-15 05:32:25 +08:00
|
|
|
{ 'include': 'block-core.json' }
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @NbdServerOptions:
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# Keep this type consistent with the nbd-server-start arguments. The
|
|
|
|
# only intended difference is using SocketAddress instead of
|
|
|
|
# SocketAddressLegacy.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# @addr: Address on which to listen.
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
2020-09-24 23:26:48 +08:00
|
|
|
# @tls-creds: ID of the TLS credentials object (since 2.6).
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
2020-09-24 23:26:48 +08:00
|
|
|
# @tls-authz: ID of the QAuthZ authorization object used to validate
|
2023-04-28 18:54:29 +08:00
|
|
|
# the client's x509 distinguished name. This object is is only
|
|
|
|
# resolved at time of use, so can be deleted and recreated on the
|
|
|
|
# fly while the NBD server is active. If missing, it will default
|
|
|
|
# to denying access (since 4.0).
|
|
|
|
#
|
|
|
|
# @max-connections: The maximum number of connections to allow at the
|
|
|
|
# same time, 0 for unlimited. Setting this to 1 also stops the
|
|
|
|
# server from advertising multiple client support (since 5.2;
|
|
|
|
# default: 0)
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'NbdServerOptions',
|
|
|
|
'data': { 'addr': 'SocketAddress',
|
|
|
|
'*tls-creds': 'str',
|
2020-09-24 23:26:54 +08:00
|
|
|
'*tls-authz': 'str',
|
|
|
|
'*max-connections': 'uint32' } }
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @nbd-server-start:
|
|
|
|
#
|
|
|
|
# Start an NBD server listening on the given host and port. Block
|
2023-04-28 18:54:29 +08:00
|
|
|
# devices can then be exported using @nbd-server-add. The NBD server
|
|
|
|
# will present them as named exports; for example, another QEMU
|
|
|
|
# instance could refer to them as "nbd:HOST:PORT:exportname=NAME".
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# Keep this type consistent with the NbdServerOptions type. The only
|
|
|
|
# intended difference is using SocketAddressLegacy instead of
|
|
|
|
# SocketAddress.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# @addr: Address on which to listen.
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
2020-09-24 23:26:48 +08:00
|
|
|
# @tls-creds: ID of the TLS credentials object (since 2.6).
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
2020-09-24 23:26:48 +08:00
|
|
|
# @tls-authz: ID of the QAuthZ authorization object used to validate
|
2023-04-28 18:54:29 +08:00
|
|
|
# the client's x509 distinguished name. This object is is only
|
|
|
|
# resolved at time of use, so can be deleted and recreated on the
|
|
|
|
# fly while the NBD server is active. If missing, it will default
|
|
|
|
# to denying access (since 4.0).
|
|
|
|
#
|
|
|
|
# @max-connections: The maximum number of connections to allow at the
|
|
|
|
# same time, 0 for unlimited. Setting this to 1 also stops the
|
|
|
|
# server from advertising multiple client support (since 5.2;
|
|
|
|
# default: 0).
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# Returns: error if the server is already running.
|
|
|
|
#
|
2020-11-18 14:41:58 +08:00
|
|
|
# Since: 1.3
|
2020-09-24 23:26:48 +08:00
|
|
|
##
|
|
|
|
{ 'command': 'nbd-server-start',
|
|
|
|
'data': { 'addr': 'SocketAddressLegacy',
|
|
|
|
'*tls-creds': 'str',
|
2020-09-24 23:26:54 +08:00
|
|
|
'*tls-authz': 'str',
|
2020-11-03 17:37:20 +08:00
|
|
|
'*max-connections': 'uint32' },
|
|
|
|
'allow-preconfig': true }
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
2020-10-27 13:05:49 +08:00
|
|
|
# @BlockExportOptionsNbdBase:
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# An NBD block export (common options shared between nbd-server-add
|
|
|
|
# and the NBD branch of block-export-add).
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @name: Export name. If unspecified, the @device parameter is used
|
|
|
|
# as the export name. (Since 2.12)
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# @description: Free-form description of the export, up to 4096 bytes.
|
2023-04-28 18:54:29 +08:00
|
|
|
# (Since 5.0)
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# Since: 5.0
|
|
|
|
##
|
2020-10-27 13:05:49 +08:00
|
|
|
{ 'struct': 'BlockExportOptionsNbdBase',
|
|
|
|
'data': { '*name': 'str', '*description': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockExportOptionsNbd:
|
|
|
|
#
|
|
|
|
# An NBD block export (distinct options used in the NBD branch of
|
|
|
|
# block-export-add).
|
|
|
|
#
|
|
|
|
# @bitmaps: Also export each of the named dirty bitmaps reachable from
|
2023-04-28 18:54:29 +08:00
|
|
|
# @device, so the NBD client can use NBD_OPT_SET_META_CONTEXT with
|
|
|
|
# the metadata context name "qemu:dirty-bitmap:BITMAP" to inspect
|
|
|
|
# each bitmap. Since 7.1 bitmap may be specified by node/name
|
|
|
|
# pair.
|
2020-10-27 13:05:49 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @allocation-depth: Also export the allocation depth map for @device,
|
|
|
|
# so the NBD client can use NBD_OPT_SET_META_CONTEXT with the
|
|
|
|
# metadata context name "qemu:allocation-depth" to inspect
|
|
|
|
# allocation details. (since 5.2)
|
2020-10-27 13:05:55 +08:00
|
|
|
#
|
2020-10-27 13:05:49 +08:00
|
|
|
# Since: 5.2
|
|
|
|
##
|
2020-09-24 23:26:49 +08:00
|
|
|
{ 'struct': 'BlockExportOptionsNbd',
|
2020-10-27 13:05:49 +08:00
|
|
|
'base': 'BlockExportOptionsNbdBase',
|
qapi: nbd-export: allow select bitmaps by node/name pair
Hi all! Current logic of relying on search through backing chain is not
safe neither convenient.
Sometimes it leads to necessity of extra bitmap copying. Also, we are
going to add "snapshot-access" driver, to access some snapshot state
through NBD. And this driver is not formally a filter, and of course
it's not a COW format driver. So, searching through backing chain will
not work. Instead of widening the workaround of bitmap searching, let's
extend the interface so that user can select bitmap precisely.
Note, that checking for bitmap active status is not copied to the new
API, I don't see a reason for it, user should understand the risks. And
anyway, bitmap from other node is unrelated to this export being
read-only or read-write.
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@openvz.org>
Message-Id: <20220314213226.362217-3-v.sementsov-og@mail.ru>
[eblake: Adjust S-o-b to Vladimir's new email, with permission]
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2022-03-15 05:32:25 +08:00
|
|
|
'data': { '*bitmaps': ['BlockDirtyBitmapOrStr'],
|
|
|
|
'*allocation-depth': 'bool' } }
|
2020-09-24 23:27:01 +08:00
|
|
|
|
2020-09-24 23:15:47 +08:00
|
|
|
##
|
|
|
|
# @BlockExportOptionsVhostUserBlk:
|
|
|
|
#
|
|
|
|
# A vhost-user-blk block export.
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @addr: The vhost-user socket on which to listen. Both 'unix' and
|
|
|
|
# 'fd' SocketAddress types are supported. Passed fds must be UNIX
|
|
|
|
# domain sockets.
|
|
|
|
#
|
|
|
|
# @logical-block-size: Logical block size in bytes. Defaults to 512
|
|
|
|
# bytes.
|
|
|
|
#
|
|
|
|
# @num-queues: Number of request virtqueues. Must be greater than 0.
|
|
|
|
# Defaults to 1.
|
2020-09-24 23:15:47 +08:00
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockExportOptionsVhostUserBlk',
|
2020-10-01 22:46:03 +08:00
|
|
|
'data': { 'addr': 'SocketAddress',
|
|
|
|
'*logical-block-size': 'size',
|
|
|
|
'*num-queues': 'uint16'} }
|
2020-09-24 23:15:47 +08:00
|
|
|
|
export/fuse: Add allow-other option
Without the allow_other mount option, no user (not even root) but the
one who started qemu/the storage daemon can access the export. Allow
users to configure the export such that such accesses are possible.
While allow_other is probably what users want, we cannot make it an
unconditional default, because passing it is only possible (for non-root
users) if the global fuse.conf configuration file allows it. Thus, the
default is an 'auto' mode, in which we first try with allow_other, and
then fall back to without.
FuseExport.allow_other reports whether allow_other was actually used as
a mount option or not. Currently, this information is not used, but a
future patch will let this field decide whether e.g. an export's UID and
GID can be changed through chmod.
One notable thing about 'auto' mode is that libfuse may print error
messages directly to stderr, and so may fusermount (which it executes).
Our export code cannot really filter or hide them. Therefore, if 'auto'
fails its first attempt and has to fall back, fusermount will print an
error message that mounting with allow_other failed.
This behavior necessitates a change to iotest 308, namely we need to
filter out this error message (because if the first attempt at mounting
with allow_other succeeds, there will be no such message).
Furthermore, common.rc's _make_test_img should use allow-other=off for
FUSE exports, because iotests generally do not need to access images
from other users, so allow-other=on or allow-other=auto have no
advantage. OTOH, allow-other=on will not work on systems where
user_allow_other is disabled, and with allow-other=auto, we get said
error message that we would need to filter out again. Just disabling
allow-other is simplest.
Signed-off-by: Max Reitz <mreitz@redhat.com>
Message-Id: <20210625142317.271673-3-mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2021-06-25 22:23:13 +08:00
|
|
|
##
|
|
|
|
# @FuseExportAllowOther:
|
|
|
|
#
|
|
|
|
# Possible allow_other modes for FUSE exports.
|
|
|
|
#
|
|
|
|
# @off: Do not pass allow_other as a mount option.
|
|
|
|
#
|
|
|
|
# @on: Pass allow_other as a mount option.
|
|
|
|
#
|
|
|
|
# @auto: Try mounting with allow_other first, and if that fails, retry
|
2023-04-28 18:54:29 +08:00
|
|
|
# without allow_other.
|
export/fuse: Add allow-other option
Without the allow_other mount option, no user (not even root) but the
one who started qemu/the storage daemon can access the export. Allow
users to configure the export such that such accesses are possible.
While allow_other is probably what users want, we cannot make it an
unconditional default, because passing it is only possible (for non-root
users) if the global fuse.conf configuration file allows it. Thus, the
default is an 'auto' mode, in which we first try with allow_other, and
then fall back to without.
FuseExport.allow_other reports whether allow_other was actually used as
a mount option or not. Currently, this information is not used, but a
future patch will let this field decide whether e.g. an export's UID and
GID can be changed through chmod.
One notable thing about 'auto' mode is that libfuse may print error
messages directly to stderr, and so may fusermount (which it executes).
Our export code cannot really filter or hide them. Therefore, if 'auto'
fails its first attempt and has to fall back, fusermount will print an
error message that mounting with allow_other failed.
This behavior necessitates a change to iotest 308, namely we need to
filter out this error message (because if the first attempt at mounting
with allow_other succeeds, there will be no such message).
Furthermore, common.rc's _make_test_img should use allow-other=off for
FUSE exports, because iotests generally do not need to access images
from other users, so allow-other=on or allow-other=auto have no
advantage. OTOH, allow-other=on will not work on systems where
user_allow_other is disabled, and with allow-other=auto, we get said
error message that we would need to filter out again. Just disabling
allow-other is simplest.
Signed-off-by: Max Reitz <mreitz@redhat.com>
Message-Id: <20210625142317.271673-3-mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2021-06-25 22:23:13 +08:00
|
|
|
#
|
|
|
|
# Since: 6.1
|
|
|
|
##
|
|
|
|
{ 'enum': 'FuseExportAllowOther',
|
|
|
|
'data': ['off', 'on', 'auto'] }
|
|
|
|
|
2020-10-28 03:05:42 +08:00
|
|
|
##
|
|
|
|
# @BlockExportOptionsFuse:
|
|
|
|
#
|
|
|
|
# Options for exporting a block graph node on some (file) mountpoint
|
|
|
|
# as a raw image.
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @mountpoint: Path on which to export the block device via FUSE. This
|
|
|
|
# must point to an existing regular file.
|
2020-10-28 03:05:42 +08:00
|
|
|
#
|
2020-10-28 03:05:44 +08:00
|
|
|
# @growable: Whether writes beyond the EOF should grow the block node
|
2023-04-28 18:54:29 +08:00
|
|
|
# accordingly. (default: false)
|
2020-10-28 03:05:44 +08:00
|
|
|
#
|
export/fuse: Add allow-other option
Without the allow_other mount option, no user (not even root) but the
one who started qemu/the storage daemon can access the export. Allow
users to configure the export such that such accesses are possible.
While allow_other is probably what users want, we cannot make it an
unconditional default, because passing it is only possible (for non-root
users) if the global fuse.conf configuration file allows it. Thus, the
default is an 'auto' mode, in which we first try with allow_other, and
then fall back to without.
FuseExport.allow_other reports whether allow_other was actually used as
a mount option or not. Currently, this information is not used, but a
future patch will let this field decide whether e.g. an export's UID and
GID can be changed through chmod.
One notable thing about 'auto' mode is that libfuse may print error
messages directly to stderr, and so may fusermount (which it executes).
Our export code cannot really filter or hide them. Therefore, if 'auto'
fails its first attempt and has to fall back, fusermount will print an
error message that mounting with allow_other failed.
This behavior necessitates a change to iotest 308, namely we need to
filter out this error message (because if the first attempt at mounting
with allow_other succeeds, there will be no such message).
Furthermore, common.rc's _make_test_img should use allow-other=off for
FUSE exports, because iotests generally do not need to access images
from other users, so allow-other=on or allow-other=auto have no
advantage. OTOH, allow-other=on will not work on systems where
user_allow_other is disabled, and with allow-other=auto, we get said
error message that we would need to filter out again. Just disabling
allow-other is simplest.
Signed-off-by: Max Reitz <mreitz@redhat.com>
Message-Id: <20210625142317.271673-3-mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2021-06-25 22:23:13 +08:00
|
|
|
# @allow-other: If this is off, only qemu's user is allowed access to
|
2023-04-28 18:54:29 +08:00
|
|
|
# this export. That cannot be changed even with chmod or chown.
|
|
|
|
# Enabling this option will allow other users access to the export
|
|
|
|
# with the FUSE mount option "allow_other". Note that using
|
|
|
|
# allow_other as a non-root user requires user_allow_other to be
|
|
|
|
# enabled in the global fuse.conf configuration file. In auto
|
|
|
|
# mode (the default), the FUSE export driver will first attempt to
|
|
|
|
# mount the export with allow_other, and if that fails, try again
|
|
|
|
# without. (since 6.1; default: auto)
|
export/fuse: Add allow-other option
Without the allow_other mount option, no user (not even root) but the
one who started qemu/the storage daemon can access the export. Allow
users to configure the export such that such accesses are possible.
While allow_other is probably what users want, we cannot make it an
unconditional default, because passing it is only possible (for non-root
users) if the global fuse.conf configuration file allows it. Thus, the
default is an 'auto' mode, in which we first try with allow_other, and
then fall back to without.
FuseExport.allow_other reports whether allow_other was actually used as
a mount option or not. Currently, this information is not used, but a
future patch will let this field decide whether e.g. an export's UID and
GID can be changed through chmod.
One notable thing about 'auto' mode is that libfuse may print error
messages directly to stderr, and so may fusermount (which it executes).
Our export code cannot really filter or hide them. Therefore, if 'auto'
fails its first attempt and has to fall back, fusermount will print an
error message that mounting with allow_other failed.
This behavior necessitates a change to iotest 308, namely we need to
filter out this error message (because if the first attempt at mounting
with allow_other succeeds, there will be no such message).
Furthermore, common.rc's _make_test_img should use allow-other=off for
FUSE exports, because iotests generally do not need to access images
from other users, so allow-other=on or allow-other=auto have no
advantage. OTOH, allow-other=on will not work on systems where
user_allow_other is disabled, and with allow-other=auto, we get said
error message that we would need to filter out again. Just disabling
allow-other is simplest.
Signed-off-by: Max Reitz <mreitz@redhat.com>
Message-Id: <20210625142317.271673-3-mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2021-06-25 22:23:13 +08:00
|
|
|
#
|
2020-10-28 03:05:42 +08:00
|
|
|
# Since: 6.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockExportOptionsFuse',
|
2020-10-28 03:05:44 +08:00
|
|
|
'data': { 'mountpoint': 'str',
|
export/fuse: Add allow-other option
Without the allow_other mount option, no user (not even root) but the
one who started qemu/the storage daemon can access the export. Allow
users to configure the export such that such accesses are possible.
While allow_other is probably what users want, we cannot make it an
unconditional default, because passing it is only possible (for non-root
users) if the global fuse.conf configuration file allows it. Thus, the
default is an 'auto' mode, in which we first try with allow_other, and
then fall back to without.
FuseExport.allow_other reports whether allow_other was actually used as
a mount option or not. Currently, this information is not used, but a
future patch will let this field decide whether e.g. an export's UID and
GID can be changed through chmod.
One notable thing about 'auto' mode is that libfuse may print error
messages directly to stderr, and so may fusermount (which it executes).
Our export code cannot really filter or hide them. Therefore, if 'auto'
fails its first attempt and has to fall back, fusermount will print an
error message that mounting with allow_other failed.
This behavior necessitates a change to iotest 308, namely we need to
filter out this error message (because if the first attempt at mounting
with allow_other succeeds, there will be no such message).
Furthermore, common.rc's _make_test_img should use allow-other=off for
FUSE exports, because iotests generally do not need to access images
from other users, so allow-other=on or allow-other=auto have no
advantage. OTOH, allow-other=on will not work on systems where
user_allow_other is disabled, and with allow-other=auto, we get said
error message that we would need to filter out again. Just disabling
allow-other is simplest.
Signed-off-by: Max Reitz <mreitz@redhat.com>
Message-Id: <20210625142317.271673-3-mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2021-06-25 22:23:13 +08:00
|
|
|
'*growable': 'bool',
|
|
|
|
'*allow-other': 'FuseExportAllowOther' },
|
2021-08-04 16:31:05 +08:00
|
|
|
'if': 'CONFIG_FUSE' }
|
2020-10-28 03:05:42 +08:00
|
|
|
|
2022-05-23 16:46:09 +08:00
|
|
|
##
|
|
|
|
# @BlockExportOptionsVduseBlk:
|
|
|
|
#
|
|
|
|
# A vduse-blk block export.
|
|
|
|
#
|
2022-06-14 13:15:32 +08:00
|
|
|
# @name: the name of VDUSE device (must be unique across the host).
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
|
|
|
# @num-queues: the number of virtqueues. Defaults to 1.
|
|
|
|
#
|
|
|
|
# @queue-size: the size of virtqueue. Defaults to 256.
|
|
|
|
#
|
|
|
|
# @logical-block-size: Logical block size in bytes. Range [512,
|
|
|
|
# PAGE_SIZE] and must be power of 2. Defaults to 512 bytes.
|
|
|
|
#
|
|
|
|
# @serial: the serial number of virtio block device. Defaults to
|
|
|
|
# empty string.
|
2022-05-23 16:46:09 +08:00
|
|
|
#
|
|
|
|
# Since: 7.1
|
|
|
|
##
|
|
|
|
{ 'struct': 'BlockExportOptionsVduseBlk',
|
2022-06-14 13:15:32 +08:00
|
|
|
'data': { 'name': 'str',
|
|
|
|
'*num-queues': 'uint16',
|
2022-05-23 16:46:09 +08:00
|
|
|
'*queue-size': 'uint16',
|
2022-06-14 13:15:31 +08:00
|
|
|
'*logical-block-size': 'size',
|
|
|
|
'*serial': 'str' } }
|
2022-05-23 16:46:09 +08:00
|
|
|
|
2020-09-24 23:27:01 +08:00
|
|
|
##
|
|
|
|
# @NbdServerAddOptions:
|
|
|
|
#
|
2020-10-27 13:05:49 +08:00
|
|
|
# An NBD block export, per legacy nbd-server-add command.
|
2020-09-24 23:27:01 +08:00
|
|
|
#
|
|
|
|
# @device: The device name or node name of the node to be exported
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @writable: Whether clients should be able to write to the device via
|
|
|
|
# the NBD connection (default false).
|
2020-09-24 23:27:11 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @bitmap: Also export a single dirty bitmap reachable from @device,
|
|
|
|
# so the NBD client can use NBD_OPT_SET_META_CONTEXT with the
|
|
|
|
# metadata context name "qemu:dirty-bitmap:BITMAP" to inspect the
|
|
|
|
# bitmap (since 4.0).
|
2020-10-27 13:05:49 +08:00
|
|
|
#
|
2020-09-24 23:27:01 +08:00
|
|
|
# Since: 5.0
|
|
|
|
##
|
|
|
|
{ 'struct': 'NbdServerAddOptions',
|
2020-10-27 13:05:49 +08:00
|
|
|
'base': 'BlockExportOptionsNbdBase',
|
2020-09-24 23:27:11 +08:00
|
|
|
'data': { 'device': 'str',
|
2020-10-27 13:05:49 +08:00
|
|
|
'*writable': 'bool', '*bitmap': 'str' } }
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @nbd-server-add:
|
|
|
|
#
|
|
|
|
# Export a block node to QEMU's embedded NBD server.
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# The export name will be used as the id for the resulting block
|
|
|
|
# export.
|
2020-09-24 23:27:04 +08:00
|
|
|
#
|
2020-09-24 23:27:13 +08:00
|
|
|
# Features:
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @deprecated: This command is deprecated. Use @block-export-add
|
|
|
|
# instead.
|
|
|
|
#
|
|
|
|
# Returns: error if the server is not running, or export with the same
|
|
|
|
# name already exists.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2020-11-18 14:41:58 +08:00
|
|
|
# Since: 1.3
|
2020-09-24 23:26:48 +08:00
|
|
|
##
|
|
|
|
{ 'command': 'nbd-server-add',
|
2020-11-03 17:37:20 +08:00
|
|
|
'data': 'NbdServerAddOptions', 'boxed': true, 'features': ['deprecated'],
|
|
|
|
'allow-preconfig': true }
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
2020-09-24 23:27:06 +08:00
|
|
|
# @BlockExportRemoveMode:
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2020-09-24 23:27:06 +08:00
|
|
|
# Mode for removing a block export.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @safe: Remove export if there are no existing connections, fail
|
|
|
|
# otherwise.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# @hard: Drop all connections immediately and remove export.
|
|
|
|
#
|
2024-01-29 19:50:06 +08:00
|
|
|
# TODO: Potential additional modes to be added in the future:
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2024-01-29 19:50:06 +08:00
|
|
|
# - hide: Just hide export from new clients, leave existing
|
|
|
|
# connections as is. Remove export after all clients are
|
|
|
|
# disconnected.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2024-01-29 19:50:06 +08:00
|
|
|
# - soft: Hide export from new clients, answer with ESHUTDOWN for
|
|
|
|
# all further requests from existing clients.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
2020-09-24 23:27:06 +08:00
|
|
|
{'enum': 'BlockExportRemoveMode', 'data': ['safe', 'hard']}
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @nbd-server-remove:
|
|
|
|
#
|
|
|
|
# Remove NBD export by name.
|
|
|
|
#
|
2020-09-24 23:27:06 +08:00
|
|
|
# @name: Block export id.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @mode: Mode of command operation. See @BlockExportRemoveMode
|
|
|
|
# description. Default is 'safe'.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2020-09-24 23:27:13 +08:00
|
|
|
# Features:
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
|
|
|
# @deprecated: This command is deprecated. Use @block-export-del
|
|
|
|
# instead.
|
2020-09-24 23:27:13 +08:00
|
|
|
#
|
2020-09-24 23:26:48 +08:00
|
|
|
# Returns: error if
|
2023-04-25 14:42:16 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# - the server is not running
|
|
|
|
# - export is not found
|
|
|
|
# - mode is 'safe' and there are existing connections
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# Since: 2.12
|
|
|
|
##
|
|
|
|
{ 'command': 'nbd-server-remove',
|
2020-09-24 23:27:13 +08:00
|
|
|
'data': {'name': 'str', '*mode': 'BlockExportRemoveMode'},
|
2020-11-03 17:37:20 +08:00
|
|
|
'features': ['deprecated'],
|
|
|
|
'allow-preconfig': true }
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @nbd-server-stop:
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# Stop QEMU's embedded NBD server, and unregister all devices
|
|
|
|
# previously added via @nbd-server-add.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2020-11-18 14:41:58 +08:00
|
|
|
# Since: 1.3
|
2020-09-24 23:26:48 +08:00
|
|
|
##
|
2020-11-03 17:37:20 +08:00
|
|
|
{ 'command': 'nbd-server-stop',
|
|
|
|
'allow-preconfig': true }
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockExportType:
|
|
|
|
#
|
|
|
|
# An enumeration of block export types
|
|
|
|
#
|
|
|
|
# @nbd: NBD export
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
2020-09-24 23:15:47 +08:00
|
|
|
# @vhost-user-blk: vhost-user-blk export (since 5.2)
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
2020-10-28 03:05:42 +08:00
|
|
|
# @fuse: FUSE export (since: 6.0)
|
2023-04-28 18:54:29 +08:00
|
|
|
#
|
2022-05-23 16:46:09 +08:00
|
|
|
# @vduse-blk: vduse-blk export (since 7.1)
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
|
|
|
# Since: 4.2
|
|
|
|
##
|
|
|
|
{ 'enum': 'BlockExportType',
|
2022-01-07 18:54:20 +08:00
|
|
|
'data': [ 'nbd',
|
2022-01-19 20:14:39 +08:00
|
|
|
{ 'name': 'vhost-user-blk',
|
|
|
|
'if': 'CONFIG_VHOST_USER_BLK_SERVER' },
|
2022-05-23 16:46:09 +08:00
|
|
|
{ 'name': 'fuse', 'if': 'CONFIG_FUSE' },
|
|
|
|
{ 'name': 'vduse-blk', 'if': 'CONFIG_VDUSE_BLK_EXPORT' } ] }
|
2020-09-24 23:26:48 +08:00
|
|
|
|
|
|
|
##
|
2020-09-24 23:26:49 +08:00
|
|
|
# @BlockExportOptions:
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# Describes a block export, i.e. how single node should be exported on
|
|
|
|
# an external interface.
|
2020-09-24 23:26:48 +08:00
|
|
|
#
|
2024-02-05 15:47:09 +08:00
|
|
|
# @type: Block export type
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @id: A unique identifier for the block export (across all export
|
|
|
|
# types)
|
2020-09-24 23:27:04 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @node-name: The node name of the block node to be exported
|
|
|
|
# (since: 5.2)
|
2020-09-24 23:27:01 +08:00
|
|
|
#
|
2020-09-24 23:27:11 +08:00
|
|
|
# @writable: True if clients should be able to write to the export
|
2023-04-28 18:54:29 +08:00
|
|
|
# (default false)
|
2020-09-24 23:27:11 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @writethrough: If true, caches are flushed after every write request
|
|
|
|
# to the export before completion is signalled. (since: 5.2;
|
|
|
|
# default: false)
|
2020-09-24 23:26:55 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @iothread: The name of the iothread object where the export will
|
|
|
|
# run. The default is to use the thread currently associated with
|
|
|
|
# the block node. (since: 5.2)
|
2020-09-29 20:55:16 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @fixed-iothread: True prevents the block node from being moved to
|
|
|
|
# another thread while the export is active. If true and
|
|
|
|
# @iothread is given, export creation fails if the block node
|
|
|
|
# cannot be moved to the iothread. The default is false.
|
|
|
|
# (since: 5.2)
|
2020-09-29 20:55:16 +08:00
|
|
|
#
|
2020-09-24 23:26:48 +08:00
|
|
|
# Since: 4.2
|
|
|
|
##
|
2020-09-24 23:26:49 +08:00
|
|
|
{ 'union': 'BlockExportOptions',
|
2020-09-24 23:26:55 +08:00
|
|
|
'base': { 'type': 'BlockExportType',
|
2020-09-24 23:27:04 +08:00
|
|
|
'id': 'str',
|
2020-10-01 22:46:03 +08:00
|
|
|
'*fixed-iothread': 'bool',
|
|
|
|
'*iothread': 'str',
|
2020-09-24 23:27:01 +08:00
|
|
|
'node-name': 'str',
|
2020-09-24 23:27:11 +08:00
|
|
|
'*writable': 'bool',
|
2020-09-24 23:26:55 +08:00
|
|
|
'*writethrough': 'bool' },
|
2020-09-24 23:26:48 +08:00
|
|
|
'discriminator': 'type',
|
|
|
|
'data': {
|
2020-09-24 23:15:47 +08:00
|
|
|
'nbd': 'BlockExportOptionsNbd',
|
2022-01-07 18:54:20 +08:00
|
|
|
'vhost-user-blk': { 'type': 'BlockExportOptionsVhostUserBlk',
|
|
|
|
'if': 'CONFIG_VHOST_USER_BLK_SERVER' },
|
2020-10-28 03:05:42 +08:00
|
|
|
'fuse': { 'type': 'BlockExportOptionsFuse',
|
2022-05-23 16:46:09 +08:00
|
|
|
'if': 'CONFIG_FUSE' },
|
|
|
|
'vduse-blk': { 'type': 'BlockExportOptionsVduseBlk',
|
|
|
|
'if': 'CONFIG_VDUSE_BLK_EXPORT' }
|
2020-09-24 23:26:48 +08:00
|
|
|
} }
|
2020-09-24 23:26:50 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @block-export-add:
|
|
|
|
#
|
|
|
|
# Creates a new block export.
|
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
##
|
|
|
|
{ 'command': 'block-export-add',
|
2020-11-03 17:37:20 +08:00
|
|
|
'data': 'BlockExportOptions', 'boxed': true,
|
|
|
|
'allow-preconfig': true }
|
2020-09-24 23:27:06 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @block-export-del:
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# Request to remove a block export. This drops the user's reference
|
|
|
|
# to the export, but the export may still stay around after this
|
|
|
|
# command returns until the shutdown of the export has completed.
|
2020-09-24 23:27:06 +08:00
|
|
|
#
|
|
|
|
# @id: Block export id.
|
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# @mode: Mode of command operation. See @BlockExportRemoveMode
|
|
|
|
# description. Default is 'safe'.
|
2020-09-24 23:27:06 +08:00
|
|
|
#
|
2023-04-28 18:54:29 +08:00
|
|
|
# Returns: Error if the export is not found or @mode is 'safe' and the
|
|
|
|
# export is still in use (e.g. by existing client connections)
|
2020-09-24 23:27:06 +08:00
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
##
|
|
|
|
{ 'command': 'block-export-del',
|
2020-11-03 17:37:20 +08:00
|
|
|
'data': { 'id': 'str', '*mode': 'BlockExportRemoveMode' },
|
|
|
|
'allow-preconfig': true }
|
2020-09-24 23:27:07 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BLOCK_EXPORT_DELETED:
|
|
|
|
#
|
|
|
|
# Emitted when a block export is removed and its id can be reused.
|
|
|
|
#
|
|
|
|
# @id: Block export id.
|
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
##
|
|
|
|
{ 'event': 'BLOCK_EXPORT_DELETED',
|
|
|
|
'data': { 'id': 'str' } }
|
2020-09-24 23:27:10 +08:00
|
|
|
|
|
|
|
##
|
|
|
|
# @BlockExportInfo:
|
|
|
|
#
|
|
|
|
# Information about a single block export.
|
|
|
|
#
|
|
|
|
# @id: The unique identifier for the block export
|
|
|
|
#
|
|
|
|
# @type: The block export type
|
|
|
|
#
|
|
|
|
# @node-name: The node name of the block node that is exported
|
|
|
|
#
|
|
|
|
# @shutting-down: True if the export is shutting down (e.g. after a
|
2023-04-28 18:54:29 +08:00
|
|
|
# block-export-del command, but before the shutdown has completed)
|
2020-09-24 23:27:10 +08:00
|
|
|
#
|
2022-05-03 15:37:35 +08:00
|
|
|
# Since: 5.2
|
2020-09-24 23:27:10 +08:00
|
|
|
##
|
|
|
|
{ 'struct': 'BlockExportInfo',
|
|
|
|
'data': { 'id': 'str',
|
|
|
|
'type': 'BlockExportType',
|
|
|
|
'node-name': 'str',
|
|
|
|
'shutting-down': 'bool' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @query-block-exports:
|
|
|
|
#
|
|
|
|
# Returns: A list of BlockExportInfo describing all block exports
|
|
|
|
#
|
|
|
|
# Since: 5.2
|
|
|
|
##
|
2020-11-03 17:37:20 +08:00
|
|
|
{ 'command': 'query-block-exports', 'returns': ['BlockExportInfo'],
|
|
|
|
'allow-preconfig': true }
|