- Devel - libvirt List Archives

[PATCH] schemas: rng: Make secret optional in storage vol
by Han Han 07 Jul '22

07 Jul '22

For a qcow2 storage volume with luks encryption created by qemu-img, its dumped storage vol XML has no secret element in encryption: <volume type='file'> ... <encryption format='luks'> </encryption> ... </volume> That will cause a failure in rng validation. Fix that validation failure. Signed-off-by: Han Han <hhan(a)redhat.com> --- src/conf/schemas/storagecommon.rng | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/src/conf/schemas/storagecommon.rng b/src/conf/schemas/storagecommon.rng index 10f1bc6a15..76714c9aad 100644 --- a/src/conf/schemas/storagecommon.rng +++ b/src/conf/schemas/storagecommon.rng @@ -24,17 +24,19 @@ </choice> </attribute> </optional> - <interleave> - <ref name="secret"/> - <optional> - <element name="cipher"> - <ref name="keycipher"/> - </element> - <element name="ivgen"> - <ref name="keyivgen"/> - </element> - </optional> - </interleave> + <optional> + <interleave> + <ref name="secret"/> + <optional> + <element name="cipher"> + <ref name="keycipher"/> + </element> + <element name="ivgen"> + <ref name="keyivgen"/> + </element> + </optional> + </interleave> + </optional> </element> </define> -- 2.36.1

2 1

[PATCH] virt-xml-validate: Fix incorrect wildcards for XML roots
by Han Han 07 Jul '22

07 Jul '22

To match the XML roots domainCapabilities and storagepoolCapabilities, the wildcards should be *domainCap* and *storagepoolCap*. Fixes: 7b0e2e4a55 Signed-off-by: Han Han <hhan(a)redhat.com> --- tools/virt-xml-validate.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/virt-xml-validate.in b/tools/virt-xml-validate.in index e444ef2fbc..2d5ba510ab 100644 --- a/tools/virt-xml-validate.in +++ b/tools/virt-xml-validate.in @@ -86,7 +86,7 @@ if [ -z "$TYPE" ]; then *domainbackup*) TYPE="domainbackup" ;; - *domaincaps*) + *domainCap*) TYPE="domaincaps" ;; *domain*) @@ -98,7 +98,7 @@ if [ -z "$TYPE" ]; then *network*) TYPE="network" ;; - *storagepoolcaps*) + *storagepoolCap*) TYPE="storagepoolcaps" ;; *pool*) -- 2.36.1

2 1

[PATCH] domain_validate: Properly terminate switch() in virDomainIOMMUDefValidate()
by Michal Privoznik 04 Jul '22

04 Jul '22

In my previous commit I've introduced virDomainIOMMUDefValidate() function with a switch() statement. However, two cases in it, though empty, were not terminated with a break statement which made compiler complain. Signed-off-by: Michal Privoznik <mprivozn(a)redhat.com> --- Merged under trivial rule. src/conf/domain_validate.c | 1 + 1 file changed, 1 insertion(+) diff --git a/src/conf/domain_validate.c b/src/conf/domain_validate.c index d35451c26a..57d4e63a26 100644 --- a/src/conf/domain_validate.c +++ b/src/conf/domain_validate.c @@ -2598,6 +2598,7 @@ virDomainIOMMUDefValidate(const virDomainIOMMUDef *iommu) case VIR_DOMAIN_IOMMU_MODEL_VIRTIO: case VIR_DOMAIN_IOMMU_MODEL_LAST: + break; } return 0; -- 2.35.1

1 0

Re: Incomplete information in the website Wiki for libvirt.org
by Martin Kletzander 04 Jul '22

04 Jul '22

On Fri, Jul 01, 2022 at 04:37:55AM -0500, Uriel Emmanuel Pelaez Hernández wrote: >Dear Web Marster from wiki.libvirt.org, > >I tried to look for the libvirtd, the demon that is suppose to run under >Linux/Unix environment, >but your site didn't show any information. Only a statement appeared: >"Create the page libvirtd " > Hi, we are slowly migrating the wiki pages to knowledge base articles due to various issues with the wiki. >Please, update your site or suggest any other weblink with the information. > Have a look at our docs page: https://libvirt.org/docs.html where you might find what you are looking for. There is a particular page about daemons here: https://libvirt.org/daemons.html >In theory CygWin use your package, but the information is incomplete too, >about this issue. > >I send this mail to these both Email address by the information displayed >in your wiki, about the contact address to solve this kind of problems. > Unfortunately I am not sure what are you trying to solve, so I don't know what clearer pointers to give you. >By now, Google Service in my region is deprecated, so the information that >the WebBrowser display is not the best. > >I send this request from my Email of Graduated Student form the University >domain. > >Best Regards, >Mr. Peláez Uriel. >Mexico City Have a nice day, Martin

1 0

[PATCH 0/3] IOMMU improvements
by Michal Privoznik 04 Jul '22

04 Jul '22

These are inspired by: https://bugzilla.redhat.com/show_bug.cgi?id=2101633 While there are some missing info to fix the actual but, I've noticed couple of areas for improvement while investigating the bug. Michal Prívozník (3): qemu_domain_address: Drop needless virDomainIOMMUModel typecast docs: Document <address/> for IOMMU device domain_validate: Disallow non-virtio IOMMU with an <address/> docs/formatdomain.rst | 3 +++ src/conf/domain_validate.c | 25 ++++++++++++++++++++++++- src/qemu/qemu_domain_address.c | 4 ++-- 3 files changed, 29 insertions(+), 3 deletions(-) -- 2.35.1

2 4

[libvirt PATCH] [pushed] Fix spelling
by Tim Wiederhake 04 Jul '22

04 Jul '22

Signed-off-by: Tim Wiederhake <twiederh(a)redhat.com> --- docs/kbase/secureboot.rst | 2 +- src/qemu/qemu_migration.c | 2 +- src/rpc/virnetmessage.c | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/kbase/secureboot.rst b/docs/kbase/secureboot.rst index ebd9d56da8..8f151c1f2a 100644 --- a/docs/kbase/secureboot.rst +++ b/docs/kbase/secureboot.rst @@ -49,7 +49,7 @@ snippet: </os> Versions older than 7.2.0 require manually providing all information -about the firmware and are not covered here. Plese refer to `the +about the firmware and are not covered here. Please refer to `the relevant documentation <../formatdomain.html#operating-system-booting>`__ for details. diff --git a/src/qemu/qemu_migration.c b/src/qemu/qemu_migration.c index 368995085f..9c3fd41761 100644 --- a/src/qemu/qemu_migration.c +++ b/src/qemu/qemu_migration.c @@ -2726,7 +2726,7 @@ qemuMigrationAnyCanResume(virDomainObj *vm, /* This should never happen since POSTCOPY_RESUME is newer than * CHANGE_PROTECTION, but let's check it anyway in case we're talking to - * a weired client. + * a weird client. */ if (job == VIR_ASYNC_JOB_MIGRATION_OUT && expectedPhase < QEMU_MIGRATION_PHASE_PERFORM_RESUME && diff --git a/src/rpc/virnetmessage.c b/src/rpc/virnetmessage.c index d298d30d57..ceba1a5a8e 100644 --- a/src/rpc/virnetmessage.c +++ b/src/rpc/virnetmessage.c @@ -437,7 +437,7 @@ int virNetMessageDecodePayload(virNetMessage *msg, * virNetMessageEncodePayloadRaw: * @msg: message to encode payload into * @data: data to encode into @msg - * @len: lenght of @data + * @len: length of @data * * Encodes message payload. If @data is NULL or @len is 0 an empty message is * encoded. -- 2.36.1

1 0

[libvirt PATCH] conf: fix error message for wrong thread_pool_size
by Ján Tomko 01 Jul '22

01 Jul '22

Fix the copy-and-paste error by referring to the correct variable. Fixes: 0df2e7df80452f81edbfeb0ee355235b533346a9 https://bugzilla.redhat.com/show_bug.cgi?id=2103132 Signed-off-by: Ján Tomko <jtomko(a)redhat.com> --- Pushed as trivial. src/conf/domain_conf.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c index fb8bf4cfec..2c2f23242e 100644 --- a/src/conf/domain_conf.c +++ b/src/conf/domain_conf.c @@ -9949,7 +9949,7 @@ virDomainFSDefParseXML(virDomainXMLOption *xmlopt, virStrToLong_i(thread_pool_size, NULL, 10, &def->thread_pool_size) < 0) { virReportError(VIR_ERR_XML_ERROR, _("cannot parse thread pool size '%s' for virtiofs"), - queue_size); + thread_pool_size); goto error; } -- 2.35.3

1 0

[PATCH] storagepoolxml2argvtest: Fix output data for 'pool-netfs-protocol-ver'
by Peter Krempa 01 Jul '22

01 Jul '22

The storage pool tests have host-specific versions which I neglected to update in commit c44930d932203b4a58dccbbeaa814fff6cea8216 thus breaking the test-suite on non-linux OSes. Fixes: c44930d932203b4a58dccbbeaa814fff6cea8216 Signed-off-by: Peter Krempa <pkrempa(a)redhat.com> --- Pushed as a build-fix. .../pool-netfs-protocol-ver-freebsd.argv | 2 +- tests/storagepoolxml2argvdata/pool-netfs-protocol-ver.argv | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver-freebsd.argv b/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver-freebsd.argv index 32cdaebcff..20954ef50c 100644 --- a/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver-freebsd.argv +++ b/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver-freebsd.argv @@ -1,5 +1,5 @@ mount \ --o nosuid,noexec,nfsvers=3 \ +-o nosuid,noexec,nfsvers=4.1 \ -t nfs \ localhost:/var/lib/libvirt/images \ /mnt diff --git a/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver.argv b/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver.argv index ed157883c0..9afc6090b8 100644 --- a/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver.argv +++ b/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver.argv @@ -1,5 +1,5 @@ mount \ --o nfsvers=3 \ +-o nfsvers=4.1 \ -t nfs \ localhost:/var/lib/libvirt/images \ /mnt -- 2.36.1

1 0

[PATCHv2] storage: pool: Allow more intricate nfs protocol versions
by Peter Krempa 01 Jul '22

01 Jul '22

Treat the 'protocolVer' field as a string so that e.g. '4.1' can be used. Forbid only ',' in the string as it's a separator of arguments for mount options. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com> --- v2: - forbid ',' in the version string. docs/formatstorage.rst | 2 +- src/conf/schemas/storagepool.rng | 4 +--- src/conf/storage_conf.c | 17 ++++++++--------- src/conf/storage_conf.h | 2 +- src/storage/storage_util.c | 4 ++-- .../pool-netfs-protocol-ver-linux.argv | 2 +- .../pool-netfs-protocol-ver.xml | 2 +- .../pool-netfs-protocol-ver.xml | 2 +- 8 files changed, 16 insertions(+), 19 deletions(-) diff --git a/docs/formatstorage.rst b/docs/formatstorage.rst index ef15c0ac5c..83d7d141ac 100644 --- a/docs/formatstorage.rst +++ b/docs/formatstorage.rst @@ -350,7 +350,7 @@ following child elements: ``protocol`` For a ``netfs`` Storage Pool provide a mechanism to define which NFS protocol version number will be used to contact the server's NFS service. The - attribute ``ver`` accepts an unsigned integer as the version number to use. + attribute ``ver`` accepts the version number to use. :since:`Since 5.1.0` ``vendor`` Provides optional information about the vendor of the storage device. This diff --git a/src/conf/schemas/storagepool.rng b/src/conf/schemas/storagepool.rng index bd24b8b8d0..d81ead532a 100644 --- a/src/conf/schemas/storagepool.rng +++ b/src/conf/schemas/storagepool.rng @@ -577,9 +577,7 @@ <ref name="sourcefmtnetfs"/> <optional> <element name="protocol"> - <attribute name="ver"> - <ref name="unsignedInt"/> - </attribute> + <attribute name="ver"/> </element> </optional> <optional> diff --git a/src/conf/storage_conf.c b/src/conf/storage_conf.c index 5da0bf20dd..79f16aadf3 100644 --- a/src/conf/storage_conf.c +++ b/src/conf/storage_conf.c @@ -483,6 +483,7 @@ virStoragePoolSourceClear(virStoragePoolSource *source) virStorageAuthDefFree(source->auth); VIR_FREE(source->vendor); VIR_FREE(source->product); + VIR_FREE(source->protocolVer); } @@ -526,7 +527,6 @@ virStoragePoolDefParseSource(xmlXPathContextPtr ctxt, virStoragePoolOptions *options; int n; g_autoptr(virStorageAuthDef) authdef = NULL; - g_autofree char *ver = NULL; g_autofree xmlNodePtr *nodeset = NULL; g_autofree char *sourcedir = NULL; VIR_XPATH_NODE_AUTORESTORE(ctxt) @@ -634,7 +634,7 @@ virStoragePoolDefParseSource(xmlXPathContextPtr ctxt, } /* Option protocol version string (NFSvN) */ - if ((ver = virXPathString("string(./protocol/@ver)", ctxt))) { + if ((source->protocolVer = virXPathString("string(./protocol/@ver)", ctxt))) { if ((source->format != VIR_STORAGE_POOL_NETFS_NFS) && (source->format != VIR_STORAGE_POOL_NETFS_AUTO)) { virReportError(VIR_ERR_CONFIG_UNSUPPORTED, @@ -643,10 +643,11 @@ virStoragePoolDefParseSource(xmlXPathContextPtr ctxt, virStoragePoolFormatFileSystemNetTypeToString(source->format)); return -1; } - if (virStrToLong_uip(ver, NULL, 0, &source->protocolVer) < 0) { - virReportError(VIR_ERR_XML_ERROR, - _("storage pool protocol ver '%s' is malformed"), - ver); + + if (strchr(source->protocolVer, ',')) { + virReportError(VIR_ERR_XML_DETAIL, + _("storage pool protocol ver '%s' must not contain ','"), + source->protocolVer); return -1; } } @@ -1099,9 +1100,7 @@ virStoragePoolSourceFormat(virBuffer *buf, if (src->auth) virStorageAuthDefFormat(buf, src->auth); - if (src->protocolVer) - virBufferAsprintf(buf, "<protocol ver='%u'/>\n", src->protocolVer); - + virBufferEscapeString(buf, "<protocol ver='%s'/>\n", src->protocolVer); virBufferEscapeString(buf, "<vendor name='%s'/>\n", src->vendor); virBufferEscapeString(buf, "<product name='%s'/>\n", src->product); diff --git a/src/conf/storage_conf.h b/src/conf/storage_conf.h index de39c3f294..a1bf243935 100644 --- a/src/conf/storage_conf.h +++ b/src/conf/storage_conf.h @@ -213,7 +213,7 @@ struct _virStoragePoolSource { int format; /* Protocol version value for netfs */ - unsigned int protocolVer; + char *protocolVer; }; typedef struct _virStoragePoolTarget virStoragePoolTarget; diff --git a/src/storage/storage_util.c b/src/storage/storage_util.c index 6ed2078b65..3871718b09 100644 --- a/src/storage/storage_util.c +++ b/src/storage/storage_util.c @@ -4201,8 +4201,8 @@ virStorageBackendFileSystemMountCmd(const char *cmdstr, virCommand *cmd = NULL; g_autofree char *nfsVers = NULL; - if (def->type == VIR_STORAGE_POOL_NETFS && def->source.protocolVer > 0) - nfsVers = g_strdup_printf("nfsvers=%u", def->source.protocolVer); + if (def->type == VIR_STORAGE_POOL_NETFS && def->source.protocolVer) + nfsVers = g_strdup_printf("nfsvers=%s", def->source.protocolVer); cmd = virCommandNew(cmdstr); if (netauto) diff --git a/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver-linux.argv b/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver-linux.argv index dac46a074f..da3e0c5927 100644 --- a/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver-linux.argv +++ b/tests/storagepoolxml2argvdata/pool-netfs-protocol-ver-linux.argv @@ -1,5 +1,5 @@ mount \ --o nodev,nosuid,noexec,nfsvers=3 \ +-o nodev,nosuid,noexec,nfsvers=4.1 \ -t nfs \ localhost:/var/lib/libvirt/images \ /mnt diff --git a/tests/storagepoolxml2xmlin/pool-netfs-protocol-ver.xml b/tests/storagepoolxml2xmlin/pool-netfs-protocol-ver.xml index 40f3f94e41..f35992e3c8 100644 --- a/tests/storagepoolxml2xmlin/pool-netfs-protocol-ver.xml +++ b/tests/storagepoolxml2xmlin/pool-netfs-protocol-ver.xml @@ -8,7 +8,7 @@ <host name='localhost'/> <dir path='/var/lib/libvirt/images'/> <format type='nfs'/> - <protocol ver='3'/> + <protocol ver='4.1'/> </source> <target> <path>/mnt</path> diff --git a/tests/storagepoolxml2xmlout/pool-netfs-protocol-ver.xml b/tests/storagepoolxml2xmlout/pool-netfs-protocol-ver.xml index 5fcad1305b..74c2f5edfe 100644 --- a/tests/storagepoolxml2xmlout/pool-netfs-protocol-ver.xml +++ b/tests/storagepoolxml2xmlout/pool-netfs-protocol-ver.xml @@ -8,7 +8,7 @@ <host name='localhost'/> <dir path='/var/lib/libvirt/images'/> <format type='nfs'/> - <protocol ver='3'/> + <protocol ver='4.1'/> </source> <target> <path>/mnt</path> -- 2.36.1

2 1

[libvirt PATCH v2] tools: add virt-qmp-proxy for proxying QMP clients to libvirt QEMU guests
by Daniel P. Berrangé 01 Jul '22

01 Jul '22

Libvirt provides QMP passthrough APIs for the QEMU driver and these are exposed in virsh. It is not especially pleasant, however, using the raw QMP JSON syntax. QEMU has a tool 'qmp-shell' which can speak QMP and exposes a human friendly interactive shell. It is not possible to use this with libvirt managed guest, however, since only one client can attach to he QMP socket at any point in time. The virt-qmp-proxy tool aims to solve this problem. It opens a UNIX socket and listens for incoming client connections, speaking QMP on the connected socket. It will forward any QMP commands received onto the running libvirt QEMU guest, and forward any replies back to the QMP client. $ virsh start demo $ virt-qmp-proxy demo demo.qmp & $ qmp-shell demo.qmp Welcome to the QMP low-level shell! Connected to QEMU 6.2.0 (QEMU) query-kvm { "return": { "enabled": true, "present": true } } Note this tool of course has the same risks as the raw libvirt QMP passthrough. It is safe to run query commands to fetch information but commands which change the QEMU state risk disrupting libvirt's management of QEMU, potentially resulting in data loss/corruption in the worst case. Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com> --- Changed in v2: - Rewrote to not be such a gross hack, specifically - Wired up usage of libvirt event loop for sock I/O - Register with libvirt for QMP events - Incrementally read from socket & try json parsing until we get a full command, instead of assuming a full command in one read - Forwarding of passed FDs in both directions (libvirt -> client untested, since AFAIK, no QMP cmd returns FDs currently) Other thought.... This patch is against libvirt.git but has a dependancy on the libvirt-python.git APIs. If we put this in libvirt-client RPM then we get a new dep on python. Perhaps better to have this live in libvirt-python.git/examples, though I would like it present as a standard tool ? Another option is to bundle with virt-install which is a python app commonly present on virt hosts ? docs/manpages/meson.build | 1 + docs/manpages/virt-qmp-proxy.rst | 120 +++++++++++ tools/meson.build | 5 + tools/virt-qmp-proxy | 360 +++++++++++++++++++++++++++++++ 4 files changed, 486 insertions(+) create mode 100644 docs/manpages/virt-qmp-proxy.rst create mode 100755 tools/virt-qmp-proxy diff --git a/docs/manpages/meson.build b/docs/manpages/meson.build index ba673cf472..4162a9969a 100644 --- a/docs/manpages/meson.build +++ b/docs/manpages/meson.build @@ -18,6 +18,7 @@ docs_man_files = [ { 'name': 'virt-pki-query-dn', 'section': '1', 'install': true }, { 'name': 'virt-pki-validate', 'section': '1', 'install': true }, { 'name': 'virt-qemu-run', 'section': '1', 'install': conf.has('WITH_QEMU') }, + { 'name': 'virt-qmp-proxy', 'section': '1', 'install': conf.has('WITH_QEMU') }, { 'name': 'virt-xml-validate', 'section': '1', 'install': true }, { 'name': 'libvirt-guests', 'section': '8', 'install': conf.has('WITH_LIBVIRTD') }, diff --git a/docs/manpages/virt-qmp-proxy.rst b/docs/manpages/virt-qmp-proxy.rst new file mode 100644 index 0000000000..30b9f6699d --- /dev/null +++ b/docs/manpages/virt-qmp-proxy.rst @@ -0,0 +1,120 @@ +============== +virt-qmp-proxy +============== + +-------------------------------------------------- +Expose a QMP proxy server for a libvirt QEMU guest +-------------------------------------------------- + +:Manual section: 1 +:Manual group: Virtualization Support + +.. contents:: + + +SYNOPSIS +======== + +``virt-qmp-proxy`` [*OPTION*]... *DOMAIN* *QMP-SOCKET-PATH* + + +DESCRIPTION +=========== + +This tool provides a way to expose a QMP proxy server that communicates +with a QEMU guest managed by libvirt. This enables standard QMP client +tools to interact with libvirt managed guests. + +**NOTE: use of this tool will result in the running QEMU guest being +marked as tainted.** It is strongly recommended that this tool *only be +used to send commands which query information* about the running guest. +If this tool is used to make changes to the state of the guest, this +may have negative interactions with the QEMU driver, resulting in an +inability to manage the guest operation thereafter, and in the worst +case **potentially lead to data loss or corruption**. + +The ``virt-qmp-proxy`` program will listen on a UNIX socket for incoming +client connections, and run the QMP protocol over the connection. Any +commands received will be sent to the running libvirt guest, and replies +sent back. + +The ``virt-qemu-proxy`` program may be interrupted (eg Ctrl-C) when it +is no longer required. The libvirt QEMU guest will continue running. + + +OPTIONS +======= + +*DOMAIN* + +The ID or UUID or Name of the libvirt QEMU guest. + +*QMP-SOCKET-PATH* + +The filesystem path at which to run the QMP server, listening for +incoming connections. + +``-c`` *CONNECTION-URI* +``--connect``\ =\ *CONNECTION-URI* + +The URI for the connection to the libvirt QEMU driver. If omitted, +a URI will be auto-detected. + +``-v``, ``--verbose`` + +Run in verbose mode, printing all QMP commands and replies that +are handled. + +``-h``, ``--help`` + +Display the command line help. + + +EXIT STATUS +=========== + +Upon successful shutdown, an exit status of 0 will be set. Upon +failure a non-zero status will be set. + + +AUTHOR +====== + +Daniel P. Berrangé + + +BUGS +==== + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html <https://libvirt.org/contact.html>`_ + +#. the bug tracker + + `https://libvirt.org/bugs.html <https://libvirt.org/bugs.html>`_ + +Alternatively, you may report bugs to your software distributor / vendor. + +COPYRIGHT +========= + +Copyright (C) 2022 by Red Hat, Inc. + + +LICENSE +======= + +``virt-qemu-proxy`` is distributed under the terms of the GNU LGPL v2+. +This is free software; see the source for copying conditions. There +is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE + + +SEE ALSO +======== + +virsh(1), `https://libvirt.org/ <https://libvirt.org/>`_, +`QMP reference <https://www.qemu.org/docs/master/interop/qemu-qmp-ref.html>`_ diff --git a/tools/meson.build b/tools/meson.build index bb28a904dc..4e959ecf0b 100644 --- a/tools/meson.build +++ b/tools/meson.build @@ -320,6 +320,11 @@ if conf.has('WITH_LIBVIRTD') endif endif +if conf.has('WITH_QEMU') + install_data('virt-qmp-proxy', + install_dir: bindir) +endif + if bash_completion_dep.found() subdir('bash-completion') endif diff --git a/tools/virt-qmp-proxy b/tools/virt-qmp-proxy new file mode 100755 index 0000000000..d85342bd2b --- /dev/null +++ b/tools/virt-qmp-proxy @@ -0,0 +1,360 @@ +#!/usr/bin/env python3 + +import argparse +import array +import libvirt +import libvirt_qemu +import os +import re +import socket +import sys +import traceback +import json +import fcntl + + +debug = False + +def get_domain(uri, domstr): + conn = libvirt.open(uri) + + dom = None + saveex = None + + def try_lookup(cb): + try: + return cb() + except libvirt.libvirtError as ex: + nonlocal saveex + if saveex is None: + saveex = ex + + if re.match(r'^\d+$', domstr): + dom = try_lookup(lambda: conn.lookupByID(int(domstr))) + + if dom is None and re.match(r'^[-a-f0-9]{36}|[a-f0-9]{32}$', domstr): + dom = try_lookup(lambda: conn.lookupByUUIDString(domstr)) + + if dom is None: + dom = try_lookup(lambda: conn.lookupByName(domstr)) + + if dom is None: + raise saveex + + if not dom.isActive(): + raise Exception("Domain must be running to use QMP") + + return conn, dom + + +class QMPProxy(object): + + def __init__(self, conn, dom, serversock, verbose): + self.conn = conn + self.dom = dom + self.verbose = verbose + + self.serversock = serversock + self.serverwatch = 0 + + self.clientsock = None + self.clientwatch = 0 + + self.api2sock = bytes([]) + self.api2sockfds = [] + + self.sock2api = bytes([]) + self.sock2apifds = [] + + self.serverwatch = libvirt.virEventAddHandle( + self.serversock.fileno(), libvirt.VIR_EVENT_HANDLE_READABLE, + self.handle_server_io, self) + + libvirt_qemu.qemuMonitorEventRegister(self.conn, self.dom, + None, + self.handle_qmp_event, + self) + + + @staticmethod + def handle_qmp_event(conn, dom, event, secs, usecs, details, self): + evdoc = { + "event": event, + "timestamp": {"seconds": secs, "microseconds": usecs } + } + if details is not None: + evdoc["data"] = details + + ev = json.dumps(evdoc) + if self.verbose: + print(ev) + ev += "\r\n" + self.api2sock += ev.encode("utf-8") + self.update_client_events() + + + def recv_with_fds(self): + # Match VIR_NET_MESSAGE_NUM_FDS_MAX in virnetprotocol.x + maxfds = 32 + fds = array.array('i') + cmsgdatalen = socket.CMSG_LEN(maxfds * fds.itemsize) + + data, cmsgdata, flags, addr = self.clientsock.recvmsg(1024, + cmsgdatalen) + for cmsg_level, cmsg_type, cmsg_data in cmsgdata: + if (cmsg_level == socket.SOL_SOCKET and + cmsg_type == socket.SCM_RIGHTS): + fds.frombytes(cmsg_data[:len(cmsg_data) - + (len(cmsg_data) % fds.itemsize)]) + else: + raise Exception("Unexpected CMSGDATA level %d type %d" % ( + cmsg_level, cmsg_type)) + + return data, [self.make_file(fd) for fd in fds] + + + def send_with_fds(self, data, fds): + cfds = [fd.fileno() for fd in fds] + + cmsgdata = [(socket.SOL_SOCKET, socket.SCM_RIGHTS, + array.array("i", cfds))] + + return self.clientsock.sendmsg([data], cmsgdata) + + + @staticmethod + def make_file(fd): + flags = fcntl.fcntl(fd, fcntl.F_GETFL) + + mask = os.O_RDONLY | os.O_WRONLY | os.O_RDWR | os.O_APPEND + flags = flags & mask + mode = "" + if flags == os.O_RDONLY: + mode = "rb" + elif flags == os.O_WRONLY: + mode = "wb" + elif flags == os.O_RDWR: + mode = "r+b" + elif flags == (os.O_WRONLY | os.O_APPEND): + mode = "ab" + elif flags == (os.O_RDWR | os.O_APPEND): + mode = "a+b" + + return os.fdopen(fd, mode) + + + def add_client(self, sock): + ver = self.conn.getVersion() + major = int(ver / 1000000) % 1000 + minor = int(ver / 1000) % 1000 + micro = ver % 1000 + + greetingobj = { + "QMP": { + "version": { + "qemu": { + "major": major, + "minor": minor, + "micro": micro, + }, + "package": f"qemu-{major}.{minor}.{micro}", + }, + "capabilities": [ + "oob" + ], + } + } + greeting = json.dumps(greetingobj) + if self.verbose: + print(greeting) + greeting += "\r\n" + + self.clientsock = sock + self.clientwatch = libvirt.virEventAddHandle( + self.clientsock.fileno(), libvirt.VIR_EVENT_HANDLE_WRITABLE, + self.handle_client_io, self) + self.api2sock += greeting.encode("utf-8") + self.update_server_events() + + + def remove_client(self): + libvirt.virEventRemoveHandle(self.clientwatch) + self.clientsock.close() + self.clientsock = None + self.clientwatch = 0 + self.update_server_events() + + self.api2sock = bytes([]) + self.api2sockfds = [] + + self.sock2api = bytes([]) + self.sock2apifds = [] + + + def update_client_events(self): + # For simplicity of tracking distinct QMP cmds and their passed FDs + # we don't try to support "pipelining", only a single cmd may be + # inflight + if len(self.api2sock) > 0: + events = libvirt.VIR_EVENT_HANDLE_WRITABLE + else: + events = libvirt.VIR_EVENT_HANDLE_READABLE + + libvirt.virEventUpdateHandle(self.clientwatch, events) + + + def update_server_events(self): + if self.clientsock is not None: + libvirt.virEventUpdateHandle(self.serverwatch, 0) + else: + libvirt.virEventUpdateHandle(self.serverwatch, + libvirt.VIR_EVENT_HANDLE_READABLE) + + + def try_command(self): + try: + cmdstr = self.sock2api.decode("utf-8") + cmd = json.loads(cmdstr) + + if self.verbose: + cmdstr = cmdstr.strip() + print(cmdstr) + except Exception as ex: + if debug: + print("Incomplete %s: %s" % ( self.sock2api, ex)) + return + + id = None + if "id" in cmd: + id = cmd["id"] + del cmd["id"] + + if cmd.get("execute", "") == "qmp_capabilities": + resobj = { + "return": {}, + } + resfds = [] + else: + if hasattr(libvirt_qemu, "qemuMonitorCommandWithFiles"): + res, resfds = libvirt_qemu.qemuMonitorCommandWithFiles( + self.dom, json.dumps(cmd), [f.fileno() for f in self.sock2apifds]) + resobj = json.loads(res) + else: + if len(self.sock2apifds) > 0: + raise Exception("FD passing not supported") + res = libvirt_qemu.qemuMonitorCommand( + self.dom, json.dumps(cmd)) + resfds = [] + resobj = json.loads(res) + + if "id" in resobj: + del resobj["id"] + if id is not None: + resobj["id"] = id + + res = json.dumps(resobj) + if self.verbose: + print(res) + res += "\r\n" + + self.sock2api = bytes([]) + self.sock2apifds = [] + self.api2sock += res.encode("utf-8") + self.api2sockfds = resfds + + + @staticmethod + def handle_client_io(watch, fd, events, self): + error = False + try: + if events & libvirt.VIR_EVENT_HANDLE_WRITABLE: + done = self.send_with_fds(self.api2sock, self.api2sockfds) + if done > 0: + self.api2sock = self.api2sock[done:] + self.api2sockfds = [] + elif events & libvirt.VIR_EVENT_HANDLE_READABLE: + data, fds = self.recv_with_fds() + if len(data) == 0: + error = True + else: + self.sock2api += data + if len(fds): + self.sock2apifds += fds + + self.try_command() + else: + error = True + except Exception as e: + global debug + if debug: + print("%s: %s" % (sys.argv[0], str(e))) + print(traceback.format_exc()) + error = True + + if error: + self.remove_client() + else: + self.update_client_events() + + + @staticmethod + def handle_server_io(watch, fd, events, self): + if self.clientsock is None: + sock, addr = self.serversock.accept() + self.add_client(sock) + else: + self.update_server_events() + + +def parse_commandline(): + parser = argparse.ArgumentParser(description="Libvirt QMP proxy") + parser.add_argument("--connect", "-c", + help="Libvirt QEMU driver connection URI") + parser.add_argument("--debug", "-d", action='store_true', + help="Display debugging information") + parser.add_argument("--verbose", "-v", action='store_true', + help="Display QMP traffic") + parser.add_argument("domain", metavar="DOMAIN", + help="Libvirt guest domain ID/UUID/Name") + parser.add_argument("sockpath", metavar="QMP-SOCK-PATH", + help="UNIX socket path for QMP server") + + return parser.parse_args() + + +def main(): + args = parse_commandline() + global debug + debug = args.debug + + if not debug: + libvirt.registerErrorHandler(lambda opaque, error: None, None) + + libvirt.virEventRegisterDefaultImpl() + + conn, dom = get_domain(args.connect, args.domain) + + if conn.getType() != "QEMU": + raise Exception("QMP proxy requires a QEMU driver connection not %s" % + conn.getType()) + + sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) + if os.path.exists(args.sockpath): + os.unlink(args.sockpath) + sock.bind(args.sockpath) + sock.listen(1) + + proxy = QMPProxy(conn, dom, sock, args.verbose) + + while True: + libvirt.virEventRunDefaultImpl() + + +try: + main() + sys.exit(0) +except Exception as e: + print("%s: %s" % (sys.argv[0], str(e))) + if debug: + print(traceback.format_exc()) + sys.exit(1) -- 2.36.1

3 2