From nobody Sat Sep 28 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1569597501; cv=none; d=zoho.com; s=zohoarc; b=eL8y0m3yDN3l04f/89wzc/btO+czCP4WzZBMyFs7AJ3IoPStch9x3JUBJj58VLj2lTuxfWvWaFxx4im6Xp8JR91NnOjYvzKMX9RL3RtKMDwaQUnB57RPE4HlYSistdcpQ/CInHh/lASHQ1FH8Kuk67WVhdJBBg4vAUwGWYk6HK4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1569597501; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=pq0mKtqgOEoGg/MX5xGq4i3Ne0MFWD3/StlBC4g+aqU=; b=JFNeld7GsTH9QA5KlUclxHZCVN6xzhESo+vhWADzfTVhHlk8Gvw07CoI9heFB73dUoTxHaxwVvbAcEayByEIpqo86N6Ywhucs0wOhAURtBA/Jwaoi3Ne9W4vxh3xvYy6wm5P9gsLyXUEDox7qkW5Ddb5evuoiDjF6f/7KQlAPrw= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1569597501403532.6031200238893; Fri, 27 Sep 2019 08:18:21 -0700 (PDT) Received: from localhost ([::1]:52334 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDs0d-0002qA-7l for importer@patchew.org; Fri, 27 Sep 2019 11:18:15 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:38917) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDqWC-0005mk-KH for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:46 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iDqWA-0005Ko-S8 for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:44 -0400 Received: from mx1.redhat.com ([209.132.183.28]:35938) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iDqWA-0005JO-Fm for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:42 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 8C4C1309BDBA for ; Fri, 27 Sep 2019 13:42:39 +0000 (UTC) Received: from localhost (ovpn-112-38.ams2.redhat.com [10.36.112.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id B80681001281; Fri, 27 Sep 2019 13:42:35 +0000 (UTC) From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Subject: [PATCH v4 1/7] vmstate: add qom interface to get id Date: Fri, 27 Sep 2019 17:42:18 +0400 Message-Id: <20190927134224.14550-2-marcandre.lureau@redhat.com> In-Reply-To: <20190927134224.14550-1-marcandre.lureau@redhat.com> References: <20190927134224.14550-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.45]); Fri, 27 Sep 2019 13:42:39 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: berrange@redhat.com, quintela@redhat.com, mprivozn@redhat.com, dgilbert@redhat.com, pbonzini@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Add an interface to get the instance id, instead of depending on Device and qdev_get_dev_path(). Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: Daniel P. Berrang=C3=A9 Acked-by: Dr. David Alan Gilbert --- MAINTAINERS | 2 ++ hw/core/Makefile.objs | 1 + hw/core/qdev.c | 14 +++++++++++++ hw/core/vmstate-if.c | 23 +++++++++++++++++++++ include/hw/vmstate-if.h | 40 ++++++++++++++++++++++++++++++++++++ include/migration/register.h | 2 ++ include/migration/vmstate.h | 2 ++ tests/Makefile.include | 1 + 8 files changed, 85 insertions(+) create mode 100644 hw/core/vmstate-if.c create mode 100644 include/hw/vmstate-if.h diff --git a/MAINTAINERS b/MAINTAINERS index bd7ee23101..b97fdd80d0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2147,6 +2147,8 @@ Migration M: Juan Quintela M: Dr. David Alan Gilbert S: Maintained +F: hw/core/vmstate-if.c +F: include/hw/vmstate-if.h F: include/migration/ F: migration/ F: scripts/vmstate-static-checker.py diff --git a/hw/core/Makefile.objs b/hw/core/Makefile.objs index fd0550d1d9..0edd9e635d 100644 --- a/hw/core/Makefile.objs +++ b/hw/core/Makefile.objs @@ -9,6 +9,7 @@ common-obj-y +=3D hotplug.o common-obj-$(CONFIG_SOFTMMU) +=3D nmi.o common-obj-$(CONFIG_SOFTMMU) +=3D vm-change-state-handler.o common-obj-y +=3D cpu.o +common-obj-y +=3D vmstate-if.o =20 common-obj-$(CONFIG_EMPTY_SLOT) +=3D empty_slot.o common-obj-$(CONFIG_XILINX_AXI) +=3D stream.o diff --git a/hw/core/qdev.c b/hw/core/qdev.c index cbad6c1d55..fe13ccb37f 100644 --- a/hw/core/qdev.c +++ b/hw/core/qdev.c @@ -1064,9 +1064,18 @@ static void device_unparent(Object *obj) } } =20 +static char * +device_vmstate_if_get_id(VMStateIf *obj) +{ + DeviceState *dev =3D DEVICE(obj); + + return qdev_get_dev_path(dev); +} + static void device_class_init(ObjectClass *class, void *data) { DeviceClass *dc =3D DEVICE_CLASS(class); + VMStateIfClass *vc =3D VMSTATE_IF_CLASS(class); =20 class->unparent =3D device_unparent; =20 @@ -1078,6 +1087,7 @@ static void device_class_init(ObjectClass *class, voi= d *data) */ dc->hotpluggable =3D true; dc->user_creatable =3D true; + vc->get_id =3D device_vmstate_if_get_id; } =20 void device_class_set_parent_reset(DeviceClass *dc, @@ -1135,6 +1145,10 @@ static const TypeInfo device_type_info =3D { .class_init =3D device_class_init, .abstract =3D true, .class_size =3D sizeof(DeviceClass), + .interfaces =3D (InterfaceInfo[]) { + { TYPE_VMSTATE_IF }, + { } + } }; =20 static void qdev_register_types(void) diff --git a/hw/core/vmstate-if.c b/hw/core/vmstate-if.c new file mode 100644 index 0000000000..bf453620fe --- /dev/null +++ b/hw/core/vmstate-if.c @@ -0,0 +1,23 @@ +/* + * VMState interface + * + * Copyright (c) 2009-2019 Red Hat Inc + * This work is licensed under the terms of the GNU GPL, version 2 or late= r. + * See the COPYING file in the top-level directory. + */ + +#include "qemu/osdep.h" +#include "hw/vmstate-if.h" + +static const TypeInfo vmstate_if_info =3D { + .name =3D TYPE_VMSTATE_IF, + .parent =3D TYPE_INTERFACE, + .class_size =3D sizeof(VMStateIfClass), +}; + +static void vmstate_register_types(void) +{ + type_register_static(&vmstate_if_info); +} + +type_init(vmstate_register_types); diff --git a/include/hw/vmstate-if.h b/include/hw/vmstate-if.h new file mode 100644 index 0000000000..8ff7f0f292 --- /dev/null +++ b/include/hw/vmstate-if.h @@ -0,0 +1,40 @@ +/* + * VMState interface + * + * Copyright (c) 2009-2019 Red Hat Inc + * This work is licensed under the terms of the GNU GPL, version 2 or late= r. + * See the COPYING file in the top-level directory. + */ + +#ifndef VMSTATE_IF_H +#define VMSTATE_IF_H + +#include "qom/object.h" + +#define TYPE_VMSTATE_IF "vmstate-if" + +#define VMSTATE_IF_CLASS(klass) \ + OBJECT_CLASS_CHECK(VMStateIfClass, (klass), TYPE_VMSTATE_IF) +#define VMSTATE_IF_GET_CLASS(obj) \ + OBJECT_GET_CLASS(VMStateIfClass, (obj), TYPE_VMSTATE_IF) +#define VMSTATE_IF(obj) \ + INTERFACE_CHECK(VMStateIf, (obj), TYPE_VMSTATE_IF) + +typedef struct VMStateIf VMStateIf; + +typedef struct VMStateIfClass { + InterfaceClass parent_class; + + char * (*get_id)(VMStateIf *obj); +} VMStateIfClass; + +static inline char *vmstate_if_get_id(VMStateIf *vmif) +{ + if (!vmif) { + return NULL; + } + + return VMSTATE_IF_GET_CLASS(vmif)->get_id(vmif); +} + +#endif /* VMSTATE_IF_H */ diff --git a/include/migration/register.h b/include/migration/register.h index a13359a08d..73149c9a01 100644 --- a/include/migration/register.h +++ b/include/migration/register.h @@ -14,6 +14,8 @@ #ifndef MIGRATION_REGISTER_H #define MIGRATION_REGISTER_H =20 +#include "hw/vmstate-if.h" + typedef struct SaveVMHandlers { /* This runs inside the iothread lock. */ SaveStateHandler *save_state; diff --git a/include/migration/vmstate.h b/include/migration/vmstate.h index 1fbfd099dd..bdcf8a1652 100644 --- a/include/migration/vmstate.h +++ b/include/migration/vmstate.h @@ -27,6 +27,8 @@ #ifndef QEMU_VMSTATE_H #define QEMU_VMSTATE_H =20 +#include "hw/vmstate-if.h" + typedef struct VMStateInfo VMStateInfo; typedef struct VMStateField VMStateField; =20 diff --git a/tests/Makefile.include b/tests/Makefile.include index 0595914526..fb5ccf3947 100644 --- a/tests/Makefile.include +++ b/tests/Makefile.include @@ -567,6 +567,7 @@ tests/test-qdev-global-props$(EXESUF): tests/test-qdev-= global-props.o \ hw/core/irq.o \ hw/core/fw-path-provider.o \ hw/core/reset.o \ + hw/core/vmstate-if.o \ $(test-qapi-obj-y) tests/test-vmstate$(EXESUF): tests/test-vmstate.o \ migration/vmstate.o migration/vmstate-types.o migration/qemu-file.o \ --=20 2.23.0 From nobody Sat Sep 28 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1569597763; cv=none; d=zoho.com; s=zohoarc; b=EXIEz+ki3KWe8v3H902xkAGqExNskWmFhu7njRRTaeQXLQRwPJMBxuFOXhiVGwWMZFxauvakRYZDj4J1c8SQl6GQg9IlVnor52hJax08iicUA4Io+NPcCPuzaXhCTtrxanFRTEL5r4W7fhTyHHdfg3W+KEahHxzAgtT/BIVDts0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1569597763; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=80Ef0QWN7alWwR0eiLGmbQyD7zJc+0K7Zq6XiIQkBzw=; b=D6u189N9xsCSlAitnxCySmlBhKLUtAcE779u3pEpTKSyBdw7t0yh8O3Ek6gAGPrMn21m/zfrydhs3BNViFGNtHa/+PkVzQTfypxgClfWDvBgCK6M40K5sNoT+AIPWL55NSO+g3qfbnHjeS7qxk0/yhGONrAaNdGAcFlQXgTLC0c= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1569597763367375.6632587656512; Fri, 27 Sep 2019 08:22:43 -0700 (PDT) Received: from localhost ([::1]:52364 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDs4v-0007G6-LD for importer@patchew.org; Fri, 27 Sep 2019 11:22:41 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:38985) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDqWI-0005rr-BT for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:53 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iDqWG-0005Mo-0C for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:50 -0400 Received: from mx1.redhat.com ([209.132.183.28]:42686) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iDqWF-0005MO-MI for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:47 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id EE6661918644 for ; Fri, 27 Sep 2019 13:42:46 +0000 (UTC) Received: from localhost (ovpn-112-38.ams2.redhat.com [10.36.112.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id 90F9B1001281; Fri, 27 Sep 2019 13:42:44 +0000 (UTC) From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Subject: [PATCH v4 2/7] vmstate: replace DeviceState with VMStateIf Date: Fri, 27 Sep 2019 17:42:19 +0400 Message-Id: <20190927134224.14550-3-marcandre.lureau@redhat.com> In-Reply-To: <20190927134224.14550-1-marcandre.lureau@redhat.com> References: <20190927134224.14550-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.70]); Fri, 27 Sep 2019 13:42:46 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: berrange@redhat.com, quintela@redhat.com, mprivozn@redhat.com, dgilbert@redhat.com, pbonzini@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Replace DeviceState dependency with VMStateIf on vmstate API. Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: Daniel P. Berrang=C3=A9 Reviewed-by: Dr. David Alan Gilbert Acked-by: Halil Pasic --- hw/block/onenand.c | 2 +- hw/core/qdev.c | 7 ++++--- hw/ide/cmd646.c | 2 +- hw/ide/isa.c | 2 +- hw/ide/piix.c | 2 +- hw/ide/via.c | 2 +- hw/misc/max111x.c | 2 +- hw/net/eepro100.c | 4 ++-- hw/nvram/eeprom93xx.c | 4 ++-- hw/ppc/spapr_drc.c | 9 +++++---- hw/ppc/spapr_iommu.c | 4 ++-- hw/s390x/s390-skeys.c | 2 +- include/migration/register.h | 2 +- include/migration/vmstate.h | 8 ++++---- migration/savevm.c | 20 ++++++++++---------- stubs/vmstate.c | 4 ++-- 16 files changed, 39 insertions(+), 37 deletions(-) diff --git a/hw/block/onenand.c b/hw/block/onenand.c index fcc5a69b90..9c233c12e4 100644 --- a/hw/block/onenand.c +++ b/hw/block/onenand.c @@ -822,7 +822,7 @@ static void onenand_realize(DeviceState *dev, Error **e= rrp) onenand_mem_setup(s); sysbus_init_irq(sbd, &s->intr); sysbus_init_mmio(sbd, &s->container); - vmstate_register(dev, + vmstate_register(VMSTATE_IF(dev), ((s->shift & 0x7f) << 24) | ((s->id.man & 0xff) << 16) | ((s->id.dev & 0xff) << 8) diff --git a/hw/core/qdev.c b/hw/core/qdev.c index fe13ccb37f..b7e28d49fb 100644 --- a/hw/core/qdev.c +++ b/hw/core/qdev.c @@ -866,7 +866,8 @@ static void device_set_realized(Object *obj, bool value= , Error **errp) dev->canonical_path =3D object_get_canonical_path(OBJECT(dev)); =20 if (qdev_get_vmsd(dev)) { - if (vmstate_register_with_alias_id(dev, -1, qdev_get_vmsd(dev)= , dev, + if (vmstate_register_with_alias_id(VMSTATE_IF(dev), + -1, qdev_get_vmsd(dev), dev, dev->instance_id_alias, dev->alias_required_for_ver= sion, &local_err) < 0) { @@ -901,7 +902,7 @@ static void device_set_realized(Object *obj, bool value= , Error **errp) local_errp); } if (qdev_get_vmsd(dev)) { - vmstate_unregister(dev, qdev_get_vmsd(dev), dev); + vmstate_unregister(VMSTATE_IF(dev), qdev_get_vmsd(dev), dev); } if (dc->unrealize) { local_errp =3D local_err ? NULL : &local_err; @@ -925,7 +926,7 @@ child_realize_fail: } =20 if (qdev_get_vmsd(dev)) { - vmstate_unregister(dev, qdev_get_vmsd(dev), dev); + vmstate_unregister(VMSTATE_IF(dev), qdev_get_vmsd(dev), dev); } =20 post_realize_fail: diff --git a/hw/ide/cmd646.c b/hw/ide/cmd646.c index f3ccd11c79..01a982acbc 100644 --- a/hw/ide/cmd646.c +++ b/hw/ide/cmd646.c @@ -301,7 +301,7 @@ static void pci_cmd646_ide_realize(PCIDevice *dev, Erro= r **errp) ide_register_restart_cb(&d->bus[i]); } =20 - vmstate_register(DEVICE(dev), 0, &vmstate_ide_pci, d); + vmstate_register(VMSTATE_IF(dev), 0, &vmstate_ide_pci, d); qemu_register_reset(cmd646_reset, d); } =20 diff --git a/hw/ide/isa.c b/hw/ide/isa.c index 7b6e283679..9c7f88b2d5 100644 --- a/hw/ide/isa.c +++ b/hw/ide/isa.c @@ -75,7 +75,7 @@ static void isa_ide_realizefn(DeviceState *dev, Error **e= rrp) ide_init_ioport(&s->bus, isadev, s->iobase, s->iobase2); isa_init_irq(isadev, &s->irq, s->isairq); ide_init2(&s->bus, s->irq); - vmstate_register(dev, 0, &vmstate_ide_isa, s); + vmstate_register(VMSTATE_IF(dev), 0, &vmstate_ide_isa, s); ide_register_restart_cb(&s->bus); } =20 diff --git a/hw/ide/piix.c b/hw/ide/piix.c index fba6bc8bff..cbaee9e2cc 100644 --- a/hw/ide/piix.c +++ b/hw/ide/piix.c @@ -159,7 +159,7 @@ static void pci_piix_ide_realize(PCIDevice *dev, Error = **errp) bmdma_setup_bar(d); pci_register_bar(dev, 4, PCI_BASE_ADDRESS_SPACE_IO, &d->bmdma_bar); =20 - vmstate_register(DEVICE(dev), 0, &vmstate_ide_pci, d); + vmstate_register(VMSTATE_IF(dev), 0, &vmstate_ide_pci, d); =20 pci_piix_init_ports(d); } diff --git a/hw/ide/via.c b/hw/ide/via.c index 7087dc676e..6b9d4c6d78 100644 --- a/hw/ide/via.c +++ b/hw/ide/via.c @@ -193,7 +193,7 @@ static void via_ide_realize(PCIDevice *dev, Error **err= p) bmdma_setup_bar(d); pci_register_bar(dev, 4, PCI_BASE_ADDRESS_SPACE_IO, &d->bmdma_bar); =20 - vmstate_register(DEVICE(dev), 0, &vmstate_ide_pci, d); + vmstate_register(VMSTATE_IF(dev), 0, &vmstate_ide_pci, d); =20 for (i =3D 0; i < 2; i++) { ide_bus_new(&d->bus[i], sizeof(d->bus[i]), DEVICE(d), i, 2); diff --git a/hw/misc/max111x.c b/hw/misc/max111x.c index a713149f16..211008ce02 100644 --- a/hw/misc/max111x.c +++ b/hw/misc/max111x.c @@ -146,7 +146,7 @@ static int max111x_init(SSISlave *d, int inputs) s->input[7] =3D 0x80; s->com =3D 0; =20 - vmstate_register(dev, -1, &vmstate_max111x, s); + vmstate_register(VMSTATE_IF(dev), -1, &vmstate_max111x, s); return 0; } =20 diff --git a/hw/net/eepro100.c b/hw/net/eepro100.c index cc2dd8b1c9..cc71a7a036 100644 --- a/hw/net/eepro100.c +++ b/hw/net/eepro100.c @@ -1815,7 +1815,7 @@ static void pci_nic_uninit(PCIDevice *pci_dev) { EEPRO100State *s =3D DO_UPCAST(EEPRO100State, dev, pci_dev); =20 - vmstate_unregister(&pci_dev->qdev, s->vmstate, s); + vmstate_unregister(VMSTATE_IF(&pci_dev->qdev), s->vmstate, s); g_free(s->vmstate); eeprom93xx_free(&pci_dev->qdev, s->eeprom); qemu_del_nic(s->nic); @@ -1874,7 +1874,7 @@ static void e100_nic_realize(PCIDevice *pci_dev, Erro= r **errp) =20 s->vmstate =3D g_memdup(&vmstate_eepro100, sizeof(vmstate_eepro100)); s->vmstate->name =3D qemu_get_queue(s->nic)->model; - vmstate_register(&pci_dev->qdev, -1, s->vmstate, s); + vmstate_register(VMSTATE_IF(&pci_dev->qdev), -1, s->vmstate, s); } =20 static void eepro100_instance_init(Object *obj) diff --git a/hw/nvram/eeprom93xx.c b/hw/nvram/eeprom93xx.c index 5b01b9b03f..07f09549ed 100644 --- a/hw/nvram/eeprom93xx.c +++ b/hw/nvram/eeprom93xx.c @@ -321,7 +321,7 @@ eeprom_t *eeprom93xx_new(DeviceState *dev, uint16_t nwo= rds) /* Output DO is tristate, read results in 1. */ eeprom->eedo =3D 1; logout("eeprom =3D 0x%p, nwords =3D %u\n", eeprom, nwords); - vmstate_register(dev, 0, &vmstate_eeprom, eeprom); + vmstate_register(VMSTATE_IF(dev), 0, &vmstate_eeprom, eeprom); return eeprom; } =20 @@ -329,7 +329,7 @@ void eeprom93xx_free(DeviceState *dev, eeprom_t *eeprom) { /* Destroy EEPROM. */ logout("eeprom =3D 0x%p\n", eeprom); - vmstate_unregister(dev, &vmstate_eeprom, eeprom); + vmstate_unregister(VMSTATE_IF(dev), &vmstate_eeprom, eeprom); g_free(eeprom); } =20 diff --git a/hw/ppc/spapr_drc.c b/hw/ppc/spapr_drc.c index 62f1a42592..17aeac3801 100644 --- a/hw/ppc/spapr_drc.c +++ b/hw/ppc/spapr_drc.c @@ -511,7 +511,7 @@ static void realize(DeviceState *d, Error **errp) error_propagate(errp, err); return; } - vmstate_register(DEVICE(drc), spapr_drc_index(drc), &vmstate_spapr_drc, + vmstate_register(VMSTATE_IF(drc), spapr_drc_index(drc), &vmstate_spapr= _drc, drc); trace_spapr_drc_realize_complete(spapr_drc_index(drc)); } @@ -523,7 +523,7 @@ static void unrealize(DeviceState *d, Error **errp) gchar *name; =20 trace_spapr_drc_unrealize(spapr_drc_index(drc)); - vmstate_unregister(DEVICE(drc), &vmstate_spapr_drc, drc); + vmstate_unregister(VMSTATE_IF(drc), &vmstate_spapr_drc, drc); root_container =3D container_get(object_get_root(), DRC_CONTAINER_PATH= ); name =3D g_strdup_printf("%x", spapr_drc_index(drc)); object_property_del(root_container, name, errp); @@ -619,7 +619,8 @@ static void realize_physical(DeviceState *d, Error **er= rp) return; } =20 - vmstate_register(DEVICE(drcp), spapr_drc_index(SPAPR_DR_CONNECTOR(drcp= )), + vmstate_register(VMSTATE_IF(drcp), + spapr_drc_index(SPAPR_DR_CONNECTOR(drcp)), &vmstate_spapr_drc_physical, drcp); qemu_register_reset(drc_physical_reset, drcp); } @@ -635,7 +636,7 @@ static void unrealize_physical(DeviceState *d, Error **= errp) return; } =20 - vmstate_unregister(DEVICE(drcp), &vmstate_spapr_drc_physical, drcp); + vmstate_unregister(VMSTATE_IF(drcp), &vmstate_spapr_drc_physical, drcp= ); qemu_unregister_reset(drc_physical_reset, drcp); } =20 diff --git a/hw/ppc/spapr_iommu.c b/hw/ppc/spapr_iommu.c index e87b3d50f7..b9e7854da9 100644 --- a/hw/ppc/spapr_iommu.c +++ b/hw/ppc/spapr_iommu.c @@ -315,7 +315,7 @@ static void spapr_tce_table_realize(DeviceState *dev, E= rror **errp) =20 QLIST_INSERT_HEAD(&spapr_tce_tables, tcet, list); =20 - vmstate_register(DEVICE(tcet), tcet->liobn, &vmstate_spapr_tce_table, + vmstate_register(VMSTATE_IF(tcet), tcet->liobn, &vmstate_spapr_tce_tab= le, tcet); } =20 @@ -418,7 +418,7 @@ static void spapr_tce_table_unrealize(DeviceState *dev,= Error **errp) { SpaprTceTable *tcet =3D SPAPR_TCE_TABLE(dev); =20 - vmstate_unregister(DEVICE(tcet), &vmstate_spapr_tce_table, tcet); + vmstate_unregister(VMSTATE_IF(tcet), &vmstate_spapr_tce_table, tcet); =20 QLIST_REMOVE(tcet, list); =20 diff --git a/hw/s390x/s390-skeys.c b/hw/s390x/s390-skeys.c index bd37f39120..5da6e5292f 100644 --- a/hw/s390x/s390-skeys.c +++ b/hw/s390x/s390-skeys.c @@ -392,7 +392,7 @@ static inline void s390_skeys_set_migration_enabled(Obj= ect *obj, bool value, register_savevm_live(TYPE_S390_SKEYS, 0, 1, &savevm_s390_storage_keys, ss); } else { - unregister_savevm(DEVICE(ss), TYPE_S390_SKEYS, ss); + unregister_savevm(VMSTATE_IF(ss), TYPE_S390_SKEYS, ss); } } =20 diff --git a/include/migration/register.h b/include/migration/register.h index 73149c9a01..00c38ebe9f 100644 --- a/include/migration/register.h +++ b/include/migration/register.h @@ -76,6 +76,6 @@ int register_savevm_live(const char *idstr, const SaveVMHandlers *ops, void *opaque); =20 -void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque); +void unregister_savevm(VMStateIf *obj, const char *idstr, void *opaque); =20 #endif diff --git a/include/migration/vmstate.h b/include/migration/vmstate.h index bdcf8a1652..1911e37d72 100644 --- a/include/migration/vmstate.h +++ b/include/migration/vmstate.h @@ -1116,22 +1116,22 @@ int vmstate_save_state_v(QEMUFile *f, const VMState= Description *vmsd, bool vmstate_save_needed(const VMStateDescription *vmsd, void *opaque); =20 /* Returns: 0 on success, -1 on failure */ -int vmstate_register_with_alias_id(DeviceState *dev, int instance_id, +int vmstate_register_with_alias_id(VMStateIf *obj, int instance_id, const VMStateDescription *vmsd, void *base, int alias_id, int required_for_version, Error **errp); =20 /* Returns: 0 on success, -1 on failure */ -static inline int vmstate_register(DeviceState *dev, int instance_id, +static inline int vmstate_register(VMStateIf *obj, int instance_id, const VMStateDescription *vmsd, void *opaque) { - return vmstate_register_with_alias_id(dev, instance_id, vmsd, + return vmstate_register_with_alias_id(obj, instance_id, vmsd, opaque, -1, 0, NULL); } =20 -void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd, +void vmstate_unregister(VMStateIf *obj, const VMStateDescription *vmsd, void *opaque); =20 struct MemoryRegion; diff --git a/migration/savevm.c b/migration/savevm.c index bb9462a54d..81f344a006 100644 --- a/migration/savevm.c +++ b/migration/savevm.c @@ -760,17 +760,17 @@ int register_savevm_live(const char *idstr, return 0; } =20 -void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque) +void unregister_savevm(VMStateIf *obj, const char *idstr, void *opaque) { SaveStateEntry *se, *new_se; char id[256] =3D ""; =20 - if (dev) { - char *path =3D qdev_get_dev_path(dev); - if (path) { - pstrcpy(id, sizeof(id), path); + if (obj) { + char *oid =3D vmstate_if_get_id(obj); + if (oid) { + pstrcpy(id, sizeof(id), oid); pstrcat(id, sizeof(id), "/"); - g_free(path); + g_free(oid); } } pstrcat(id, sizeof(id), idstr); @@ -784,7 +784,7 @@ void unregister_savevm(DeviceState *dev, const char *id= str, void *opaque) } } =20 -int vmstate_register_with_alias_id(DeviceState *dev, int instance_id, +int vmstate_register_with_alias_id(VMStateIf *obj, int instance_id, const VMStateDescription *vmsd, void *opaque, int alias_id, int required_for_version, @@ -802,8 +802,8 @@ int vmstate_register_with_alias_id(DeviceState *dev, in= t instance_id, se->vmsd =3D vmsd; se->alias_id =3D alias_id; =20 - if (dev) { - char *id =3D qdev_get_dev_path(dev); + if (obj) { + char *id =3D vmstate_if_get_id(obj); if (id) { if (snprintf(se->idstr, sizeof(se->idstr), "%s/", id) >=3D sizeof(se->idstr)) { @@ -834,7 +834,7 @@ int vmstate_register_with_alias_id(DeviceState *dev, in= t instance_id, return 0; } =20 -void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd, +void vmstate_unregister(VMStateIf *obj, const VMStateDescription *vmsd, void *opaque) { SaveStateEntry *se, *new_se; diff --git a/stubs/vmstate.c b/stubs/vmstate.c index e1e89b87f0..6951d9fdc5 100644 --- a/stubs/vmstate.c +++ b/stubs/vmstate.c @@ -3,7 +3,7 @@ =20 const VMStateDescription vmstate_dummy =3D {}; =20 -int vmstate_register_with_alias_id(DeviceState *dev, +int vmstate_register_with_alias_id(VMStateIf *obj, int instance_id, const VMStateDescription *vmsd, void *base, int alias_id, @@ -13,7 +13,7 @@ int vmstate_register_with_alias_id(DeviceState *dev, return 0; } =20 -void vmstate_unregister(DeviceState *dev, +void vmstate_unregister(VMStateIf *obj, const VMStateDescription *vmsd, void *opaque) { --=20 2.23.0 From nobody Sat Sep 28 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1569594464; cv=none; d=zoho.com; s=zohoarc; b=jIqLJNGn0Ekf9M6JhenXkgEVo/DHBnQIAOgTeJm2LVtWGqRVm4VVbVetHGef1HAuV4hYTG08CiG/Zib/Ktjj8AsRd9DjbuZ6jqZolHnttUElifWQ0anzfmMVSQx0LQyld+cXG85fdyaCV2RTml9fl5E0ctQvIugc6ni7bXjncs4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1569594464; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=eLGTPFDtpPulo2L1J/4cykwwqIg4tH1ycxg6KFzoNtI=; b=UvWITx0yZzIDWKfVNW8VXFaTMCkyplf2gotCypVv0g35N5YhR7KOheNMCJgI8Sj0xgCRW1EfnSgnnTORMHwBb9Qz1tW3B668rkSTVge2/M30klAv6bwjn7l8/wGgJ+VoVpd6SCv5NLAmHFSYYl08L6IZdh7q+64PHfv1GxCvNYU= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1569594464202387.4911875904478; Fri, 27 Sep 2019 07:27:44 -0700 (PDT) Received: from localhost ([::1]:51634 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDrDi-0002zA-9S for importer@patchew.org; Fri, 27 Sep 2019 10:27:42 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39045) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDqWP-00061v-Qe for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:59 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iDqWN-0005OB-S4 for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:57 -0400 Received: from mx1.redhat.com ([209.132.183.28]:18791) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iDqWN-0005O0-JN for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:42:55 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id CEAE4A44AC7 for ; Fri, 27 Sep 2019 13:42:54 +0000 (UTC) Received: from localhost (ovpn-112-38.ams2.redhat.com [10.36.112.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id 5AEB3194B6; Fri, 27 Sep 2019 13:42:50 +0000 (UTC) From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Subject: [PATCH v4 3/7] docs: start a document to describe D-Bus usage Date: Fri, 27 Sep 2019 17:42:20 +0400 Message-Id: <20190927134224.14550-4-marcandre.lureau@redhat.com> In-Reply-To: <20190927134224.14550-1-marcandre.lureau@redhat.com> References: <20190927134224.14550-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.68]); Fri, 27 Sep 2019 13:42:54 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: berrange@redhat.com, quintela@redhat.com, mprivozn@redhat.com, dgilbert@redhat.com, pbonzini@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Signed-off-by: Marc-Andr=C3=A9 Lureau --- MAINTAINERS | 5 +++ docs/interop/dbus.rst | 99 ++++++++++++++++++++++++++++++++++++++++++ docs/interop/index.rst | 1 + 3 files changed, 105 insertions(+) create mode 100644 docs/interop/dbus.rst diff --git a/MAINTAINERS b/MAINTAINERS index b97fdd80d0..219a76f0a1 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2157,6 +2157,11 @@ F: tests/migration-test.c F: docs/devel/migration.rst F: qapi/migration.json =20 +D-Bus +M: Marc-Andr=C3=A9 Lureau +S: Maintained +F: docs/interop/dbus.rst + Seccomp M: Eduardo Otubo S: Supported diff --git a/docs/interop/dbus.rst b/docs/interop/dbus.rst new file mode 100644 index 0000000000..3d760e4882 --- /dev/null +++ b/docs/interop/dbus.rst @@ -0,0 +1,99 @@ +=3D=3D=3D=3D=3D +D-Bus +=3D=3D=3D=3D=3D + +Introduction +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +QEMU may be running with various helper processes involved: + - vhost-user* processes (gpu, virtfs, input, etc...) + - TPM emulation (or other devices) + - user networking (slirp) + - network services (DHCP/DNS, samba/ftp etc) + - background tasks (compression, streaming etc) + - client UI + - admin & cli + +Having several processes allows stricter security rules, as well as +greater modularity. + +While QEMU itself uses QMP as primary IPC (and Spice/VNC for remote +display), D-Bus is the de facto IPC of choice on Unix systems. The +wire format is machine friendly, good bindings exist for various +languages, and there are various tools available. + +Using a bus, helper processes can discover and communicate with each +other easily, without going through QEMU. The bus topology is also +easier to apprehend and debug than a mesh. However, it is wise to +consider the security aspects of it. + +Security +=3D=3D=3D=3D=3D=3D=3D=3D + +A QEMU D-Bus bus should be private to a single VM. Thus, only +cooperative tasks are running on the same bus to serve the VM. + +D-Bus, the protocol and standard, doesn't have mechanisms to enforce +security between peers once the connection is established. Peers may +have additional mechanisms to enforce security rules, based for +example on UNIX credentials. However, because the daemon has +controlled who can send/recv messages to who, doesn't magically make +this secure. The semantics of the actual methods implemented using +D-Bus are just as critical. Peers need to carefully validate any +information they received from a peer with a different trust level. + +dbus-daemon policy +------------------ + +dbus-daemon can enforce various policies based on the UID/GID of the +processes that are connected to it. It is thus a good idea to run +helpers as different UID from QEMU and set appropriate policies. + +Depending on the use case, you may choose different scenarios: + + - Everything the same UID + + - Convenient for developers + - Improved reliability - crash of one part doens't take + out entire VM + - No security benefit over traditional QEMU + + - Two UIDs, one for QEMU, one for dbus & helpers + + - Moderately improved security isolation + + - Many UIDs, one for QEMU one for dbus and one for each helpers + + - Best security isolation + - Complex to manager distinct UIDs needed for each VM + +For example, to allow only ``qemu`` user to talk to ``qemu-helper`` +``org.qemu.Helper1`` service, a dbus-daemon policy may contain: + +.. code:: xml + + + + + + + + + + + +dbus-daemon can also perfom SELinux checks based on the security +context of the source and the target. For example, ``virtiofs_t`` +could be allowed to send a message to ``svirt_t``, but ``virtiofs_t`` +wouldn't be allowed to send a message to ``virtiofs_t``. + +See dbus-daemon man page for details. + +Guidelines +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +When implementing new D-Bus interfaces, it is recommended to follow +the "D-Bus API Design Guidelines": +https://dbus.freedesktop.org/doc/dbus-api-design.html + +The "org.qemu.*" prefix is reserved for the QEMU project. diff --git a/docs/interop/index.rst b/docs/interop/index.rst index 3e33fb5933..ded134ea75 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -13,6 +13,7 @@ Contents: :maxdepth: 2 =20 bitmaps + dbus live-block-operations pr-helper qemu-ga --=20 2.23.0 From nobody Sat Sep 28 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1569598288; cv=none; d=zoho.com; s=zohoarc; b=OUy6FRGDzI1n1uDsI/g4uKHdsF2Q053kyubh1yIniv4NCFqmwfEo7f8Z3mkvC6bsFh43PZgnWbZng7bT5kaMHG2SdCaZH624kG9WsN3eVm6IhXJ0fNPVHwftO49Wvm564fkZ3D3clkZuNv3Ue0m8gDOdk/sxm/JLaqsaVQyjyAQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1569598288; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=G8K/N+Al4CZLVGz13g7fbrfBNlTaJAQWD2dwv0sP8Kc=; b=kXuqDfDsTa+tt/gBPvEbwJwxGjaz2+IjtdxxyuQDN0TSqVh2stP4TkVLsmia86SzAJq/k3aokNdAv6/VS9eK4tjzgXFz/dkbt0d41ELR9EkgEVssUzL0XotBBXHBLvXwIldzZzpSoK/VXvddIJ8jH3qeR5wrKQI/vEHThwTEn/c= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1569598288989297.301798102877; Fri, 27 Sep 2019 08:31:28 -0700 (PDT) Received: from localhost ([::1]:52444 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDsDL-0007EE-Fl for importer@patchew.org; Fri, 27 Sep 2019 11:31:23 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39103) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDqWX-0006DX-66 for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:06 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iDqWV-0005Q2-OF for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:04 -0400 Received: from mx1.redhat.com ([209.132.183.28]:35884) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iDqWV-0005Pn-FK for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:03 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id B5C4D301A3AE for ; Fri, 27 Sep 2019 13:43:02 +0000 (UTC) Received: from localhost (ovpn-112-38.ams2.redhat.com [10.36.112.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id 22C1710018F8; Fri, 27 Sep 2019 13:42:58 +0000 (UTC) From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Subject: [PATCH v4 4/7] util: add dbus helper unit Date: Fri, 27 Sep 2019 17:42:21 +0400 Message-Id: <20190927134224.14550-5-marcandre.lureau@redhat.com> In-Reply-To: <20190927134224.14550-1-marcandre.lureau@redhat.com> References: <20190927134224.14550-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.41]); Fri, 27 Sep 2019 13:43:02 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: berrange@redhat.com, quintela@redhat.com, mprivozn@redhat.com, dgilbert@redhat.com, pbonzini@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Signed-off-by: Marc-Andr=C3=A9 Lureau --- MAINTAINERS | 2 ++ include/qemu/dbus.h | 18 +++++++++++++++ util/Makefile.objs | 3 +++ util/dbus.c | 55 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 78 insertions(+) create mode 100644 include/qemu/dbus.h create mode 100644 util/dbus.c diff --git a/MAINTAINERS b/MAINTAINERS index 219a76f0a1..dccea79d48 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2160,6 +2160,8 @@ F: qapi/migration.json D-Bus M: Marc-Andr=C3=A9 Lureau S: Maintained +F: util/dbus.c +F: include/qemu/dbus.h F: docs/interop/dbus.rst =20 Seccomp diff --git a/include/qemu/dbus.h b/include/qemu/dbus.h new file mode 100644 index 0000000000..efd74bef96 --- /dev/null +++ b/include/qemu/dbus.h @@ -0,0 +1,18 @@ +/* + * Helpers for using D-Bus + * + * Copyright (C) 2019 Red Hat, Inc. + * + * This work is licensed under the terms of the GNU GPL, version 2. See + * the COPYING file in the top-level directory. + */ + +#ifndef DBUS_H +#define DBUS_H + +#include + +GStrv qemu_dbus_get_queued_owners(GDBusConnection *connection, + const char *name); + +#endif /* DBUS_H */ diff --git a/util/Makefile.objs b/util/Makefile.objs index 41bf59d127..f435cfbd64 100644 --- a/util/Makefile.objs +++ b/util/Makefile.objs @@ -54,5 +54,8 @@ util-obj-$(CONFIG_INOTIFY1) +=3D filemonitor-inotify.o util-obj-$(CONFIG_LINUX) +=3D vfio-helpers.o util-obj-$(CONFIG_POSIX) +=3D drm.o util-obj-y +=3D guest-random.o +util-obj-$(CONFIG_GIO) +=3D dbus.o +dbus.o-cflags =3D $(GIO_CFLAGS) +dbus.o-libs =3D $(GIO_LIBS) =20 stub-obj-y +=3D filemonitor-stub.o diff --git a/util/dbus.c b/util/dbus.c new file mode 100644 index 0000000000..bb51870e54 --- /dev/null +++ b/util/dbus.c @@ -0,0 +1,55 @@ +/* + * Helpers for using D-Bus + * + * Copyright (C) 2019 Red Hat, Inc. + * + * This work is licensed under the terms of the GNU GPL, version 2. See + * the COPYING file in the top-level directory. + */ + +#include "qemu/osdep.h" +#include "qemu/dbus.h" +#include "qemu/error-report.h" + +/* + * qemu_dbus_get_queued_owners() - return the list of queued unique names + * @connection: A GDBusConnection + * @name: a service name + * + * Return: a GStrv of unique names, or NULL on failure. + */ +GStrv +qemu_dbus_get_queued_owners(GDBusConnection *connection, const char *name) +{ + g_autoptr(GDBusProxy) proxy =3D NULL; + g_autoptr(GVariant) result =3D NULL; + g_autoptr(GVariant) child =3D NULL; + g_autoptr(GError) err =3D NULL; + + proxy =3D g_dbus_proxy_new_sync(connection, G_DBUS_PROXY_FLAGS_NONE, N= ULL, + "org.freedesktop.DBus", + "/org/freedesktop/DBus", + "org.freedesktop.DBus", + NULL, &err); + if (!proxy) { + error_report("Failed to create DBus proxy: %s", err->message); + return NULL; + } + + result =3D g_dbus_proxy_call_sync(proxy, "ListQueuedOwners", + g_variant_new("(s)", name), + G_DBUS_CALL_FLAGS_NO_AUTO_START, + -1, NULL, &err); + if (!result) { + if (g_error_matches(err, + G_DBUS_ERROR, + G_DBUS_ERROR_NAME_HAS_NO_OWNER)) { + return g_new0(char *, 1); + } + error_report("Failed to call ListQueuedOwners: %s", err->message); + return NULL; + } + + child =3D g_variant_get_child_value(result, 0); + return g_variant_dup_strv(child, NULL); +} --=20 2.23.0 From nobody Sat Sep 28 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1569596939; cv=none; d=zoho.com; s=zohoarc; b=brtVVnChvO+UeBg9lE5Sm0j/V9Oz5pEsrZ6GhrpG318iERoNwWQYGC3D3bjHuRpj0hfm9ZFFTOHSWhnyk+ovZKF0bmC9g31EvogARJIOh8llOiiACiWidbA4Zxdnlt7hR05gYvzd62jg1eLIjzqQf2vc+nBLN5ZcZN06iKG4ImM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1569596939; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=zfrc4AT9Cx1uxzCUUKx5DcXodhQlfs0nVmG90rfKDv4=; b=ku+YWorUfsRxUp2cZE9otjYVlcTINCWTwkTRsaUrotNhzp8HqGNd5ZSG7VL4erNU0AiYIDIuDH2nLXFvICn10i7KZ4LfcYzicAl8otURZVQOTNtWFzZQoumy1I6nDj1qWT2V2ipyM0h0YdrWqgVXispz0Nnm7VOyCJrW4dQCjA0= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1569596939391651.6898258107653; Fri, 27 Sep 2019 08:08:59 -0700 (PDT) Received: from localhost ([::1]:52170 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDrrd-000187-P5 for importer@patchew.org; Fri, 27 Sep 2019 11:08:57 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39130) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDqWh-0006Tw-3Q for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:17 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iDqWe-0005R2-9v for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:14 -0400 Received: from mx1.redhat.com ([209.132.183.28]:40322) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iDqWe-0005Qu-0j for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:12 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 439BD3065603 for ; Fri, 27 Sep 2019 13:43:11 +0000 (UTC) Received: from localhost (ovpn-112-38.ams2.redhat.com [10.36.112.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id 368B8600C6; Fri, 27 Sep 2019 13:43:06 +0000 (UTC) From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Subject: [PATCH v4 5/7] Add dbus-vmstate object Date: Fri, 27 Sep 2019 17:42:22 +0400 Message-Id: <20190927134224.14550-6-marcandre.lureau@redhat.com> In-Reply-To: <20190927134224.14550-1-marcandre.lureau@redhat.com> References: <20190927134224.14550-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.47]); Fri, 27 Sep 2019 13:43:11 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: berrange@redhat.com, quintela@redhat.com, mprivozn@redhat.com, dgilbert@redhat.com, pbonzini@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" When instantiated, this object will connect to the given D-Bus bus "addr". During migration, it will take/restore the data from org.qemu.VMState1 instances. See documentation for details. Signed-off-by: Marc-Andr=C3=A9 Lureau --- MAINTAINERS | 2 + backends/Makefile.objs | 4 + backends/dbus-vmstate.c | 496 ++++++++++++++++++++++++++++++++++ docs/interop/dbus-vmstate.rst | 74 +++++ docs/interop/dbus.rst | 5 + docs/interop/index.rst | 1 + 6 files changed, 582 insertions(+) create mode 100644 backends/dbus-vmstate.c create mode 100644 docs/interop/dbus-vmstate.rst diff --git a/MAINTAINERS b/MAINTAINERS index dccea79d48..b6325494ad 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2160,9 +2160,11 @@ F: qapi/migration.json D-Bus M: Marc-Andr=C3=A9 Lureau S: Maintained +F: backends/dbus-vmstate.c F: util/dbus.c F: include/qemu/dbus.h F: docs/interop/dbus.rst +F: docs/interop/dbus-vmstate.rst =20 Seccomp M: Eduardo Otubo diff --git a/backends/Makefile.objs b/backends/Makefile.objs index f0691116e8..28a847cd57 100644 --- a/backends/Makefile.objs +++ b/backends/Makefile.objs @@ -17,3 +17,7 @@ endif common-obj-$(call land,$(CONFIG_VHOST_USER),$(CONFIG_VIRTIO)) +=3D vhost-u= ser.o =20 common-obj-$(CONFIG_LINUX) +=3D hostmem-memfd.o + +common-obj-$(CONFIG_GIO) +=3D dbus-vmstate.o +dbus-vmstate.o-cflags =3D $(GIO_CFLAGS) +dbus-vmstate.o-libs =3D $(GIO_LIBS) diff --git a/backends/dbus-vmstate.c b/backends/dbus-vmstate.c new file mode 100644 index 0000000000..f799d6ddaf --- /dev/null +++ b/backends/dbus-vmstate.c @@ -0,0 +1,496 @@ +/* + * QEMU dbus-vmstate + * + * Copyright (C) 2019 Red Hat Inc + * + * Authors: + * Marc-Andr=C3=A9 Lureau + * + * This work is licensed under the terms of the GNU GPL, version 2 or late= r. + * See the COPYING file in the top-level directory. + */ + +#include "qemu/osdep.h" +#include "qemu/units.h" +#include "qemu/dbus.h" +#include "qemu/error-report.h" +#include "qapi/error.h" +#include "qom/object_interfaces.h" +#include "qapi/qmp/qerror.h" +#include "migration/vmstate.h" + +typedef struct DBusVMState DBusVMState; +typedef struct DBusVMStateClass DBusVMStateClass; + +#define TYPE_DBUS_VMSTATE "dbus-vmstate" +#define DBUS_VMSTATE(obj) \ + OBJECT_CHECK(DBusVMState, (obj), TYPE_DBUS_VMSTATE) +#define DBUS_VMSTATE_GET_CLASS(obj) \ + OBJECT_GET_CLASS(DBusVMStateClass, (obj), TYPE_DBUS_VMSTATE) +#define DBUS_VMSTATE_CLASS(klass) \ + OBJECT_CLASS_CHECK(DBusVMStateClass, (klass), TYPE_DBUS_VMSTATE) + +struct DBusVMStateClass { + ObjectClass parent_class; +}; + +struct DBusVMState { + Object parent; + + GDBusConnection *bus; + char *dbus_addr; + char *id_list; + + uint32_t data_size; + uint8_t *data; +}; + +static const GDBusPropertyInfo vmstate_property_info[] =3D { + { -1, (char *) "Id", (char *) "s", + G_DBUS_PROPERTY_INFO_FLAGS_READABLE, NULL }, +}; + +static const GDBusPropertyInfo * const vmstate_property_info_pointers[] = =3D { + &vmstate_property_info[0], + NULL +}; + +static const GDBusInterfaceInfo vmstate1_interface_info =3D { + -1, + (char *) "org.qemu.VMState1", + (GDBusMethodInfo **) NULL, + (GDBusSignalInfo **) NULL, + (GDBusPropertyInfo **) &vmstate_property_info_pointers, + NULL, +}; + +#define DBUS_VMSTATE_SIZE_LIMIT (1 * MiB) + +static GHashTable * +get_id_list_set(DBusVMState *self) +{ + g_auto(GStrv) ids =3D NULL; + g_autoptr(GHashTable) set =3D NULL; + int i; + + if (!self->id_list) { + return NULL; + } + + ids =3D g_strsplit(self->id_list, ",", -1); + set =3D g_hash_table_new_full(g_str_hash, g_str_equal, g_free, NULL); + for (i =3D 0; ids[i]; i++) { + g_hash_table_add(set, ids[i]); + ids[i] =3D NULL; + } + + return g_steal_pointer(&set); +} + +static GHashTable * +dbus_get_proxies(DBusVMState *self, GError **err) +{ + g_autoptr(GHashTable) proxies =3D NULL; + g_autoptr(GHashTable) ids =3D NULL; + g_auto(GStrv) names =3D NULL; + size_t i; + + ids =3D get_id_list_set(self); + proxies =3D g_hash_table_new_full(g_str_hash, g_str_equal, + g_free, g_object_unref); + + names =3D qemu_dbus_get_queued_owners(self->bus, "org.qemu.VMState1"); + if (!names) { + return NULL; + } + + for (i =3D 0; names[i]; i++) { + g_autoptr(GDBusProxy) proxy =3D NULL; + g_autoptr(GVariant) result =3D NULL; + g_autofree char *id =3D NULL; + size_t size; + + proxy =3D g_dbus_proxy_new_sync(self->bus, G_DBUS_PROXY_FLAGS_NONE, + (GDBusInterfaceInfo *) &vmstate1_interface_info, + names[i], + "/org/qemu/VMState1", + "org.qemu.VMState1", + NULL, err); + if (!proxy) { + return NULL; + } + + result =3D g_dbus_proxy_get_cached_property(proxy, "Id"); + if (!result) { + g_set_error_literal(err, G_IO_ERROR, G_IO_ERROR_FAILED, + "VMState Id property is missing."); + return NULL; + } + + id =3D g_variant_dup_string(result, &size); + if (ids && !g_hash_table_remove(ids, id)) { + g_clear_pointer(&id, g_free); + g_clear_object(&proxy); + continue; + } + if (size =3D=3D 0 || size >=3D 256) { + g_set_error(err, G_IO_ERROR, G_IO_ERROR_FAILED, + "VMState Id '%s' is invalid.", id); + return NULL; + } + + if (!g_hash_table_insert(proxies, id, proxy)) { + g_set_error(err, G_IO_ERROR, G_IO_ERROR_FAILED, + "Duplicated VMState Id '%s'", id); + return NULL; + } + id =3D NULL; + proxy =3D NULL; + + g_clear_pointer(&result, g_variant_unref); + } + + if (ids) { + g_autofree char **left =3D NULL; + + left =3D (char **)g_hash_table_get_keys_as_array(ids, NULL); + if (*left) { + g_autofree char *leftids =3D g_strjoinv(",", left); + g_set_error(err, G_IO_ERROR, G_IO_ERROR_FAILED, + "Required VMState Id are missing: %s", leftids); + return NULL; + } + } + + return g_steal_pointer(&proxies); +} + +static int +dbus_load_state_proxy(GDBusProxy *proxy, const uint8_t *data, size_t size) +{ + g_autoptr(GError) err =3D NULL; + g_autoptr(GVariant) result =3D NULL; + g_autoptr(GVariant) value =3D NULL; + + value =3D g_variant_new_fixed_array(G_VARIANT_TYPE_BYTE, + data, size, sizeof(char)); + result =3D g_dbus_proxy_call_sync(proxy, "Load", + g_variant_new("(@ay)", + g_steal_pointer(&value)), + G_DBUS_CALL_FLAGS_NO_AUTO_START, + -1, NULL, &err); + if (!result) { + error_report("Failed to Load: %s", err->message); + return -1; + } + + return 0; +} + +static int dbus_vmstate_post_load(void *opaque, int version_id) +{ + DBusVMState *self =3D DBUS_VMSTATE(opaque); + g_autoptr(GInputStream) m =3D NULL; + g_autoptr(GDataInputStream) s =3D NULL; + g_autoptr(GError) err =3D NULL; + g_autoptr(GHashTable) proxies =3D NULL; + uint32_t nelem; + + proxies =3D dbus_get_proxies(self, &err); + if (!proxies) { + error_report("Failed to get proxies: %s", err->message); + return -1; + } + + m =3D g_memory_input_stream_new_from_data(self->data, self->data_size,= NULL); + s =3D g_data_input_stream_new(m); + g_data_input_stream_set_byte_order(s, G_DATA_STREAM_BYTE_ORDER_BIG_END= IAN); + + nelem =3D g_data_input_stream_read_uint32(s, NULL, &err); + if (err) { + goto error; + } + + while (nelem > 0) { + GDBusProxy *proxy =3D NULL; + uint32_t len; + gsize bytes_read, avail; + char id[256]; + + len =3D g_data_input_stream_read_uint32(s, NULL, &err); + if (err) { + goto error; + } + if (len >=3D 256) { + error_report("Invalid DBus vmstate proxy name %u", len); + return -1; + } + if (!g_input_stream_read_all(G_INPUT_STREAM(s), id, len, + &bytes_read, NULL, &err)) { + goto error; + } + g_return_val_if_fail(bytes_read =3D=3D len, -1); + id[len] =3D 0; + + proxy =3D g_hash_table_lookup(proxies, id); + if (!proxy) { + error_report("Failed to find proxy Id '%s'", id); + return -1; + } + + len =3D g_data_input_stream_read_uint32(s, NULL, &err); + avail =3D g_buffered_input_stream_get_available( + G_BUFFERED_INPUT_STREAM(s)); + + if (len > DBUS_VMSTATE_SIZE_LIMIT || len > avail) { + error_report("Invalid vmstate size: %u", len); + return -1; + } + + if (dbus_load_state_proxy(proxy, + g_buffered_input_stream_peek_buffer(G_BUFFERED_INPUT_STREA= M(s), + NULL), + len) < 0) { + error_report("Failed to restore Id '%s'", id); + return -1; + } + + if (!g_seekable_seek(G_SEEKABLE(s), len, G_SEEK_CUR, NULL, &err)) { + goto error; + } + + nelem -=3D 1; + } + + return 0; + +error: + error_report("Failed to read from stream: %s", err->message); + return -1; +} + +static void +dbus_save_state_proxy(gpointer key, + gpointer value, + gpointer user_data) +{ + GDataOutputStream *s =3D user_data; + const char *id =3D key; + GDBusProxy *proxy =3D value; + g_autoptr(GVariant) result =3D NULL; + g_autoptr(GVariant) child =3D NULL; + g_autoptr(GError) err =3D NULL; + const uint8_t *data; + gsize size; + + result =3D g_dbus_proxy_call_sync(proxy, "Save", + NULL, G_DBUS_CALL_FLAGS_NO_AUTO_START, + -1, NULL, &err); + if (!result) { + error_report("Failed to Save: %s", err->message); + return; + } + + child =3D g_variant_get_child_value(result, 0); + data =3D g_variant_get_fixed_array(child, &size, sizeof(char)); + if (!data) { + error_report("Failed to Save: not a byte array"); + return; + } + if (size > DBUS_VMSTATE_SIZE_LIMIT) { + error_report("Too large vmstate data to save: %lu", size); + return; + } + + if (!g_data_output_stream_put_uint32(s, strlen(id), NULL, &err) || + !g_data_output_stream_put_string(s, id, NULL, &err) || + !g_data_output_stream_put_uint32(s, size, NULL, &err) || + !g_output_stream_write_all(G_OUTPUT_STREAM(s), + data, size, NULL, NULL, &err)) { + error_report("Failed to write to stream: %s", err->message); + } +} + +static int dbus_vmstate_pre_save(void *opaque) +{ + DBusVMState *self =3D DBUS_VMSTATE(opaque); + g_autoptr(GOutputStream) m =3D NULL; + g_autoptr(GDataOutputStream) s =3D NULL; + g_autoptr(GHashTable) proxies =3D NULL; + g_autoptr(GError) err =3D NULL; + + proxies =3D dbus_get_proxies(self, &err); + if (!proxies) { + error_report("Failed to get proxies: %s", err->message); + return -1; + } + + m =3D g_memory_output_stream_new_resizable(); + s =3D g_data_output_stream_new(m); + g_data_output_stream_set_byte_order(s, G_DATA_STREAM_BYTE_ORDER_BIG_EN= DIAN); + + if (!g_data_output_stream_put_uint32(s, g_hash_table_size(proxies), + NULL, &err)) { + error_report("Failed to write to stream: %s", err->message); + return -1; + } + + g_hash_table_foreach(proxies, dbus_save_state_proxy, s); + + if (g_memory_output_stream_get_size(G_MEMORY_OUTPUT_STREAM(m)) + > UINT32_MAX) { + error_report("DBus vmstate buffer is too large"); + return -1; + } + + if (!g_output_stream_close(G_OUTPUT_STREAM(m), NULL, &err)) { + error_report("Failed to close stream: %s", err->message); + return -1; + } + + g_free(self->data); + self->data_size =3D + g_memory_output_stream_get_size(G_MEMORY_OUTPUT_STREAM(m)); + self->data =3D + g_memory_output_stream_steal_data(G_MEMORY_OUTPUT_STREAM(m)); + + return 0; +} + +static const VMStateDescription dbus_vmstate =3D { + .name =3D TYPE_DBUS_VMSTATE, + .version_id =3D 0, + .pre_save =3D dbus_vmstate_pre_save, + .post_load =3D dbus_vmstate_post_load, + .fields =3D (VMStateField[]) { + VMSTATE_UINT32(data_size, DBusVMState), + VMSTATE_VBUFFER_ALLOC_UINT32(data, DBusVMState, 0, 0, data_size), + VMSTATE_END_OF_LIST() + } +}; + +static void +dbus_vmstate_complete(UserCreatable *uc, Error **errp) +{ + DBusVMState *self =3D DBUS_VMSTATE(uc); + GError *err =3D NULL; + GDBusConnection *bus; + + if (!object_resolve_path_type("", TYPE_DBUS_VMSTATE, NULL)) { + error_setg(errp, "There is already an instance of %s", + TYPE_DBUS_VMSTATE); + return; + } + + if (!self->dbus_addr) { + error_setg(errp, QERR_MISSING_PARAMETER, "addr"); + return; + } + + bus =3D g_dbus_connection_new_for_address_sync(self->dbus_addr, + G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT | + G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION, + NULL, NULL, &err); + if (err) { + error_setg(errp, "failed to connect to DBus: '%s'", err->message); + g_clear_error(&err); + } + + self->bus =3D bus; + + if (vmstate_register(VMSTATE_IF(self), -1, &dbus_vmstate, self) < 0) { + error_setg(errp, "Failed to register vmstate"); + } +} + +static void +dbus_vmstate_finalize(Object *o) +{ + DBusVMState *self =3D DBUS_VMSTATE(o); + + vmstate_unregister(VMSTATE_IF(self), &dbus_vmstate, self); + + g_clear_object(&self->bus); + g_free(self->dbus_addr); + g_free(self->id_list); + g_free(self->data); +} + +static char * +get_dbus_addr(Object *o, Error **errp) +{ + DBusVMState *self =3D DBUS_VMSTATE(o); + + return g_strdup(self->dbus_addr); +} + +static void +set_dbus_addr(Object *o, const char *str, Error **errp) +{ + DBusVMState *self =3D DBUS_VMSTATE(o); + + g_free(self->dbus_addr); + self->dbus_addr =3D g_strdup(str); +} + +static char * +get_id_list(Object *o, Error **errp) +{ + DBusVMState *self =3D DBUS_VMSTATE(o); + + return g_strdup(self->id_list); +} + +static void +set_id_list(Object *o, const char *str, Error **errp) +{ + DBusVMState *self =3D DBUS_VMSTATE(o); + + g_free(self->id_list); + self->id_list =3D g_strdup(str); +} + +static char * +dbus_vmstate_get_id(VMStateIf *vmif) +{ + return g_strdup(TYPE_DBUS_VMSTATE); +} + +static void +dbus_vmstate_class_init(ObjectClass *oc, void *data) +{ + UserCreatableClass *ucc =3D USER_CREATABLE_CLASS(oc); + VMStateIfClass *vc =3D VMSTATE_IF_CLASS(oc); + + ucc->complete =3D dbus_vmstate_complete; + vc->get_id =3D dbus_vmstate_get_id; + + object_class_property_add_str(oc, "addr", + get_dbus_addr, set_dbus_addr, + &error_abort); + object_class_property_add_str(oc, "id-list", + get_id_list, set_id_list, + &error_abort); +} + +static const TypeInfo dbus_vmstate_info =3D { + .name =3D TYPE_DBUS_VMSTATE, + .parent =3D TYPE_OBJECT, + .instance_size =3D sizeof(DBusVMState), + .instance_finalize =3D dbus_vmstate_finalize, + .class_size =3D sizeof(DBusVMStateClass), + .class_init =3D dbus_vmstate_class_init, + .interfaces =3D (InterfaceInfo[]) { + { TYPE_USER_CREATABLE }, + { TYPE_VMSTATE_IF }, + { } + } +}; + +static void +register_types(void) +{ + type_register_static(&dbus_vmstate_info); +} + +type_init(register_types); diff --git a/docs/interop/dbus-vmstate.rst b/docs/interop/dbus-vmstate.rst new file mode 100644 index 0000000000..8693891640 --- /dev/null +++ b/docs/interop/dbus-vmstate.rst @@ -0,0 +1,74 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +D-Bus VMState +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Introduction +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The QEMU dbus-vmstate object's aim is to migrate helpers' data running +on a QEMU D-Bus bus. (refer to the :doc:`dbus` document for +recommendation on D-Bus usage) + +Upon migration, QEMU will go through the queue of +``org.qemu.VMState1`` D-Bus name owners and query their ``Id``. It +must be unique among the helpers. + +It will then save arbitrary data of each Id to be transferred in the +migration stream and restored/loaded at the corresponding destination +helper. + +The data amount to be transferred is limited to 1Mb. The state must be +saved quickly (a few seconds maximum). (D-Bus imposes a time limit on +reply anyway, and migration would fail if data isn't given quickly +enough.) + +dbus-vmstate object can be configured with the expected list of +helpers by setting its ``id-list`` property, with a comma-separated +``Id`` list. + +Interface +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +On object path ``/org/qemu/VMState1``, the following +``org.qemu.VMState1`` interface should be implemented: + +.. code:: xml + + + + + + + + + + + +"Id" property +------------- + +A string that identifies the helper uniquely. (maximum 256 bytes +including terminating NUL byte) + +.. note:: + + The helper ID namespace is a separate namespace. In particular, it is n= ot + related to QEMU "id" used in -object/-device objects. + +Load(in u8[] bytes) method +-------------------------- + +The method called on destination with the state to restore. + +The helper may be initially started in a waiting state (with +an --incoming argument for example), and it may resume on success. + +An error may be returned to the caller. + +Save(out u8[] bytes) method +--------------------------- + +The method called on the source to get the current state to be +migrated. The helper should continue to run normally. + +An error may be returned to the caller. diff --git a/docs/interop/dbus.rst b/docs/interop/dbus.rst index 3d760e4882..d9af608dc9 100644 --- a/docs/interop/dbus.rst +++ b/docs/interop/dbus.rst @@ -97,3 +97,8 @@ the "D-Bus API Design Guidelines": https://dbus.freedesktop.org/doc/dbus-api-design.html =20 The "org.qemu.*" prefix is reserved for the QEMU project. + +QEMU Interfaces +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +:doc:`dbus-vmstate` diff --git a/docs/interop/index.rst b/docs/interop/index.rst index ded134ea75..049387ac6d 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -14,6 +14,7 @@ Contents: =20 bitmaps dbus + dbus-vmstate live-block-operations pr-helper qemu-ga --=20 2.23.0 From nobody Sat Sep 28 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1569597033; cv=none; d=zoho.com; s=zohoarc; b=jL7zD5TLvu19+lRVcevw7onfhvz78feboMsbkALeHYLgO9LZofajCjGsvc6DCdJOCk5lz4MRilcAsJ0hotcNuw+bosSDGIa4LEKfovo3ufXWok4MtvhYfnxo8Crc807ngl1WEXL+9kOxAi7NV3q8Mo5iY3RwtdwIUdXNbCmZdcA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1569597033; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=HpLdpErDCKGtVKQxnHpGp75UJZguYAe+PhH2SriPIbw=; b=ia6gRmZVzYgo6OLRZKL9EMy5T5MeBPdHSk+no2gp/5FK7wY0Udj5Px2/a3TQ2wVvVDFwr1HV+G99E06m2JdQ0bo9nn+kyKggURjDmxDSKPCoqX0UDfPiHEQVc3QcSVpYst6HXvOPngAA10Pq3icd0Vgr9oYbpqZdb8CTQEIaaXI= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1569597033422170.6521770288864; Fri, 27 Sep 2019 08:10:33 -0700 (PDT) Received: from localhost ([::1]:52196 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDrt9-0002wc-Aa for importer@patchew.org; Fri, 27 Sep 2019 11:10:31 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39157) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDqWm-0006cf-Bp for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:21 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iDqWl-0005S4-7J for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:20 -0400 Received: from mx1.redhat.com ([209.132.183.28]:52448) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iDqWl-0005Rs-1u for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:19 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 51E23307D9CF for ; Fri, 27 Sep 2019 13:43:18 +0000 (UTC) Received: from localhost (ovpn-112-38.ams2.redhat.com [10.36.112.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3DC2B5D6A7; Fri, 27 Sep 2019 13:43:14 +0000 (UTC) From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Subject: [PATCH v4 6/7] configure: add GDBUS_CODEGEN Date: Fri, 27 Sep 2019 17:42:23 +0400 Message-Id: <20190927134224.14550-7-marcandre.lureau@redhat.com> In-Reply-To: <20190927134224.14550-1-marcandre.lureau@redhat.com> References: <20190927134224.14550-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.48]); Fri, 27 Sep 2019 13:43:18 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: berrange@redhat.com, quintela@redhat.com, mprivozn@redhat.com, dgilbert@redhat.com, pbonzini@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" gdbus-codegen generated code requires gio-unix on Unix, so add it to GIO libs/cflags. Signed-off-by: Marc-Andr=C3=A9 Lureau --- configure | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/configure b/configure index 397bb476e1..54f4b9c667 100755 --- a/configure +++ b/configure @@ -3631,10 +3631,16 @@ if $pkg_config --atleast-version=3D$glib_req_ver gi= o-2.0; then gio=3Dyes gio_cflags=3D$($pkg_config --cflags gio-2.0) gio_libs=3D$($pkg_config --libs gio-2.0) + gdbus_codegen=3D$($pkg_config --variable=3Dgdbus_codegen gio-2.0) else gio=3Dno fi =20 +if $pkg_config --atleast-version=3D$glib_req_ver gio-unix-2.0; then + gio_cflags=3D"$gio_cflags $($pkg_config --cflags gio-unix-2.0)" + gio_libs=3D"$gio_libs $($pkg_config --libs gio-unix-2.0)" +fi + # Sanity check that the current size_t matches the # size that glib thinks it should be. This catches # problems on multi-arch where people try to build @@ -6782,6 +6788,7 @@ if test "$gio" =3D "yes" ; then echo "CONFIG_GIO=3Dy" >> $config_host_mak echo "GIO_CFLAGS=3D$gio_cflags" >> $config_host_mak echo "GIO_LIBS=3D$gio_libs" >> $config_host_mak + echo "GDBUS_CODEGEN=3D$gdbus_codegen" >> $config_host_mak fi echo "CONFIG_TLS_PRIORITY=3D\"$tls_priority\"" >> $config_host_mak if test "$gnutls" =3D "yes" ; then --=20 2.23.0 From nobody Sat Sep 28 16:22:11 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1569598600; cv=none; d=zoho.com; s=zohoarc; b=kieA/3LGWmfq9zY19QGGBUldQDm+I2c1leaTA11O4mR5pOfaNF6dCridUkgW0DBhQvenURB0I7hQWjlij6j8EHabS6Ox/OeIWMTPwTTH/iZHtArPHSI8SFQ1IAMJSTyw0dXUJYcwfm6jcWfp+3Zt+imC4S2NYIps9qXE7RfP1PE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1569598600; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=1pYsGWDzo601H8QYn8steKVv9mXaKKC8txGy+1QRzTU=; b=JzF/vynnp/LtJTsf1SOxw5ei9L2O7BHA2VIsZwrVVLrq+80bcQmtSt35Q/jv/2otpKpU1+Y9gRL8Fh+PAjD2RuH/VGluSpEncgSYIMWMRQWBEw/uBXa+fHdQ9ghK2Rb8fTf9v9DgGS7X1C3RrCe5lw3PyuiDGuh5lc7mAmZv5FA= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1569598600360419.1478160770241; Fri, 27 Sep 2019 08:36:40 -0700 (PDT) Received: from localhost ([::1]:52488 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDsIM-00041f-Pf for importer@patchew.org; Fri, 27 Sep 2019 11:36:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39197) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iDqWx-0006tE-IU for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:34 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iDqWu-0005Ta-Iw for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:31 -0400 Received: from mx1.redhat.com ([209.132.183.28]:59456) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iDqWu-0005TJ-97 for qemu-devel@nongnu.org; Fri, 27 Sep 2019 09:43:28 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 86B2610C0516 for ; Fri, 27 Sep 2019 13:43:27 +0000 (UTC) Received: from localhost (ovpn-112-38.ams2.redhat.com [10.36.112.38]) by smtp.corp.redhat.com (Postfix) with ESMTP id F2C3810001BC; Fri, 27 Sep 2019 13:43:22 +0000 (UTC) From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= To: qemu-devel@nongnu.org Subject: [PATCH v4 7/7] tests: add dbus-vmstate-test Date: Fri, 27 Sep 2019 17:42:24 +0400 Message-Id: <20190927134224.14550-8-marcandre.lureau@redhat.com> In-Reply-To: <20190927134224.14550-1-marcandre.lureau@redhat.com> References: <20190927134224.14550-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.6.2 (mx1.redhat.com [10.5.110.65]); Fri, 27 Sep 2019 13:43:27 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: berrange@redhat.com, quintela@redhat.com, mprivozn@redhat.com, dgilbert@redhat.com, pbonzini@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" Signed-off-by: Marc-Andr=C3=A9 Lureau --- MAINTAINERS | 1 + tests/Makefile.include | 19 +- tests/dbus-vmstate-daemon.sh | 95 +++++++++ tests/dbus-vmstate-test.c | 399 +++++++++++++++++++++++++++++++++++ tests/dbus-vmstate1.xml | 12 ++ 5 files changed, 525 insertions(+), 1 deletion(-) create mode 100755 tests/dbus-vmstate-daemon.sh create mode 100644 tests/dbus-vmstate-test.c create mode 100644 tests/dbus-vmstate1.xml diff --git a/MAINTAINERS b/MAINTAINERS index b6325494ad..f1a8f9cacd 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2161,6 +2161,7 @@ D-Bus M: Marc-Andr=C3=A9 Lureau S: Maintained F: backends/dbus-vmstate.c +F: tests/dbus-vmstate* F: util/dbus.c F: include/qemu/dbus.h F: docs/interop/dbus.rst diff --git a/tests/Makefile.include b/tests/Makefile.include index fb5ccf3947..0406a5b502 100644 --- a/tests/Makefile.include +++ b/tests/Makefile.include @@ -158,7 +158,9 @@ check-qtest-pci-$(CONFIG_RTL8139_PCI) +=3D tests/rtl813= 9-test$(EXESUF) check-qtest-pci-$(CONFIG_VGA) +=3D tests/display-vga-test$(EXESUF) check-qtest-pci-$(CONFIG_HDA) +=3D tests/intel-hda-test$(EXESUF) check-qtest-pci-$(CONFIG_IVSHMEM_DEVICE) +=3D tests/ivshmem-test$(EXESUF) - +ifneq ($(GDBUS_CODEGEN),) +check-qtest-pci-$(CONFIG_GIO) +=3D tests/dbus-vmstate-test$(EXESUF) +endif check-qtest-i386-$(CONFIG_ISA_TESTDEV) =3D tests/endianness-test$(EXESUF) check-qtest-i386-y +=3D tests/fdc-test$(EXESUF) check-qtest-i386-y +=3D tests/ide-test$(EXESUF) @@ -621,6 +623,19 @@ tests/qapi-schema/doc-good.test.texi: $(SRC_PATH)/test= s/qapi-schema/doc-good.jso @mv tests/qapi-schema/doc-good-qapi-doc.texi $@ @rm -f tests/qapi-schema/doc-good-qapi-*.[ch] tests/qapi-schema/doc-good-= qmp-*.[ch] =20 +tests/dbus-vmstate1.h tests/dbus-vmstate1.c: tests/dbus-vmstate1-gen-times= tamp ; +tests/dbus-vmstate1-gen-timestamp: $(SRC_PATH)/tests/dbus-vmstate1.xml + $(call quiet-command,$(GDBUS_CODEGEN) $< \ + --interface-prefix org.qemu --generate-c-code tests/dbus-vmstate1, \ + "GEN","$(@:%-timestamp=3D%)") + @>$@ + +tests/dbus-vmstate-test.o-cflags :=3D -DSRCDIR=3D"$(SRC_PATH)" +tests/dbus-vmstate1.o-cflags :=3D $(GIO_CFLAGS) +tests/dbus-vmstate1.o-libs :=3D $(GIO_LIBS) + +tests/dbus-vmstate-test.o: tests/dbus-vmstate1.h + tests/test-string-output-visitor$(EXESUF): tests/test-string-output-visito= r.o $(test-qapi-obj-y) tests/test-string-input-visitor$(EXESUF): tests/test-string-input-visitor.= o $(test-qapi-obj-y) tests/test-qmp-event$(EXESUF): tests/test-qmp-event.o $(test-qapi-obj-y) t= ests/test-qapi-events.o @@ -823,6 +838,7 @@ tests/test-filter-mirror$(EXESUF): tests/test-filter-mi= rror.o $(qtest-obj-y) tests/test-filter-redirector$(EXESUF): tests/test-filter-redirector.o $(qt= est-obj-y) tests/test-x86-cpuid-compat$(EXESUF): tests/test-x86-cpuid-compat.o $(qtes= t-obj-y) tests/ivshmem-test$(EXESUF): tests/ivshmem-test.o contrib/ivshmem-server/i= vshmem-server.o $(libqos-pc-obj-y) $(libqos-spapr-obj-y) +tests/dbus-vmstate-test$(EXESUF): tests/dbus-vmstate-test.o tests/dbus-vms= tate1.o $(libqos-pc-obj-y) $(libqos-spapr-obj-y) tests/vhost-user-bridge$(EXESUF): tests/vhost-user-bridge.o $(test-util-ob= j-y) libvhost-user.a tests/test-uuid$(EXESUF): tests/test-uuid.o $(test-util-obj-y) tests/test-arm-mptimer$(EXESUF): tests/test-arm-mptimer.o @@ -1180,6 +1196,7 @@ check-clean: rm -rf $(check-unit-y) tests/*.o $(QEMU_IOTESTS_HELPERS-y) rm -rf $(sort $(foreach target,$(SYSEMU_TARGET_LIST), $(check-qtest-$(tar= get)-y)) $(check-qtest-generic-y)) rm -f tests/test-qapi-gen-timestamp + rm -f tests/dbus-vmstate1-gen-timestamp rm -rf $(TESTS_VENV_DIR) $(TESTS_RESULTS_DIR) =20 clean: check-clean diff --git a/tests/dbus-vmstate-daemon.sh b/tests/dbus-vmstate-daemon.sh new file mode 100755 index 0000000000..c4394ac918 --- /dev/null +++ b/tests/dbus-vmstate-daemon.sh @@ -0,0 +1,95 @@ +#!/bin/sh + +# dbus-daemon wrapper script for dbus-vmstate testing +# +# This script allows to tweak the dbus-daemon policy during the test +# to test different configurations. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, see . +# +# Copyright (C) 2019 Red Hat, Inc. + +write_config() +{ + CONF=3D"$1" + cat > "$CONF" < + session + unix:tmpdir=3D/tmp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + contexts/dbus_contexts + + +EOF +} + +ARGS=3D +for arg in "$@" +do + case $arg in + --config-file=3D*) + CONF=3D"${arg#*=3D}" + write_config "$CONF" + ARGS=3D"$ARGS $1" + shift + ;; + *) + ARGS=3D"$ARGS $1" + shift + ;; + esac +done + +exec dbus-daemon $ARGS diff --git a/tests/dbus-vmstate-test.c b/tests/dbus-vmstate-test.c new file mode 100644 index 0000000000..34818c1e79 --- /dev/null +++ b/tests/dbus-vmstate-test.c @@ -0,0 +1,399 @@ +#include "qemu/osdep.h" +#include +#include +#include "libqtest.h" +#include "qemu-common.h" +#include "dbus-vmstate1.h" + +static char *workdir; + +typedef struct TestServerId { + const char *name; + const char *data; + size_t size; +} TestServerId; + +static const TestServerId idA =3D { + "idA", "I'am\0idA!", sizeof("I'am\0idA!") +}; + +static const TestServerId idB =3D { + "idB", "I'am\0idB!", sizeof("I'am\0idB!") +}; + +typedef struct TestServer { + const TestServerId *id; + bool save_called; + bool load_called; +} TestServer; + +typedef struct Test { + const char *id_list; + bool migrate_fail; + bool without_dst_b; + TestServer srcA; + TestServer dstA; + TestServer srcB; + TestServer dstB; + GMainLoop *loop; + QTestState *src_qemu; +} Test; + +static gboolean +vmstate_load(VMState1 *object, GDBusMethodInvocation *invocation, + const gchar *arg_data, gpointer user_data) +{ + TestServer *h =3D user_data; + g_autoptr(GVariant) var =3D NULL; + GVariant *args; + const uint8_t *data; + size_t size; + + args =3D g_dbus_method_invocation_get_parameters(invocation); + var =3D g_variant_get_child_value(args, 0); + data =3D g_variant_get_fixed_array(var, &size, sizeof(char)); + g_assert_cmpuint(size, =3D=3D, h->id->size); + g_assert(!memcmp(data, h->id->data, h->id->size)); + h->load_called =3D true; + + g_dbus_method_invocation_return_value(invocation, g_variant_new("()")); + return TRUE; +} + +static gboolean +vmstate_save(VMState1 *object, GDBusMethodInvocation *invocation, + gpointer user_data) +{ + TestServer *h =3D user_data; + GVariant *var; + + var =3D g_variant_new_fixed_array(G_VARIANT_TYPE_BYTE, + h->id->data, h->id->size, sizeof(char)= ); + g_dbus_method_invocation_return_value(invocation, + g_variant_new("(@ay)", var)); + h->save_called =3D true; + + return TRUE; +} + +static gboolean +wait_for_migration_complete(gpointer user_data) +{ + Test *test =3D user_data; + QDict *rsp_return; + bool stop =3D false; + const char *status; + + qtest_qmp_send(test->src_qemu, "{ 'execute': 'query-migrate' }"); + rsp_return =3D qtest_qmp_receive_success(test->src_qemu, NULL, NULL); + status =3D qdict_get_str(rsp_return, "status"); + if (g_str_equal(status, "completed") || g_str_equal(status, "failed"))= { + stop =3D true; + g_assert_cmpstr(status, =3D=3D, + test->migrate_fail ? "failed" : "completed"); + } + qobject_unref(rsp_return); + + if (stop) { + g_main_loop_quit(test->loop); + } + return stop ? G_SOURCE_REMOVE : G_SOURCE_CONTINUE; +} + +static void migrate(QTestState *who, const char *uri) +{ + QDict *args, *rsp; + + args =3D qdict_new(); + qdict_put_str(args, "uri", uri); + + rsp =3D qtest_qmp(who, "{ 'execute': 'migrate', 'arguments': %p }", ar= gs); + + g_assert(qdict_haskey(rsp, "return")); + qobject_unref(rsp); +} + +typedef struct WaitNamed { + GMainLoop *loop; + bool named; +} WaitNamed; + +static void +named_cb(GDBusConnection *connection, + const gchar *name, + gpointer user_data) +{ + WaitNamed *t =3D user_data; + + t->named =3D true; + g_main_loop_quit(t->loop); +} + +static GDBusConnection * +get_connection(Test *test, guint *ownid) +{ + g_autofree gchar *addr =3D NULL; + WaitNamed *wait; + GError *err =3D NULL; + GDBusConnection *c; + + wait =3D g_new0(WaitNamed, 1); + wait->loop =3D test->loop; + addr =3D g_dbus_address_get_for_bus_sync(G_BUS_TYPE_SESSION, NULL, &er= r); + g_assert_no_error(err); + + c =3D g_dbus_connection_new_for_address_sync( + addr, + G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION | + G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT, + NULL, NULL, &err); + g_assert_no_error(err); + *ownid =3D g_bus_own_name_on_connection(c, "org.qemu.VMState1", + G_BUS_NAME_OWNER_FLAGS_NONE, + named_cb, named_cb, wait, g_free= ); + if (!wait->named) { + g_main_loop_run(wait->loop); + } + + return c; +} + +static GDBusObjectManagerServer * +get_server(GDBusConnection *conn, TestServer *s, const TestServerId *id) +{ + g_autoptr(GDBusObjectSkeleton) sk =3D NULL; + g_autoptr(VMState1Skeleton) v =3D NULL; + GDBusObjectManagerServer *os; + + s->id =3D id; + os =3D g_dbus_object_manager_server_new("/org/qemu"); + sk =3D g_dbus_object_skeleton_new("/org/qemu/VMState1"); + + v =3D VMSTATE1_SKELETON(vmstate1_skeleton_new()); + g_object_set(v, "id", id->name, NULL); + + g_signal_connect(v, "handle-load", G_CALLBACK(vmstate_load), s); + g_signal_connect(v, "handle-save", G_CALLBACK(vmstate_save), s); + + g_dbus_object_skeleton_add_interface(sk, G_DBUS_INTERFACE_SKELETON(v)); + g_dbus_object_manager_server_export(os, sk); + g_dbus_object_manager_server_set_connection(os, conn); + + return os; +} + +static void +set_id_list(Test *test, QTestState *s) +{ + if (!test->id_list) { + return; + } + + g_assert(!qmp_rsp_is_err(qtest_qmp(s, + "{ 'execute': 'qom-set', 'arguments': " + "{ 'path': '/objects/dv', 'property': 'id-list', 'value': %s } }", + test->id_list))); +} +static void +test_dbus_vmstate(Test *test) +{ + g_autofree char *src_qemu_args =3D NULL; + g_autofree char *dst_qemu_args =3D NULL; + g_autoptr(GTestDBus) srcbus =3D NULL; + g_autoptr(GTestDBus) dstbus =3D NULL; + g_autoptr(GDBusConnection) srcconnA =3D NULL; + g_autoptr(GDBusConnection) srcconnB =3D NULL; + g_autoptr(GDBusConnection) dstconnA =3D NULL; + g_autoptr(GDBusConnection) dstconnB =3D NULL; + g_autoptr(GDBusObjectManagerServer) srcserverA =3D NULL; + g_autoptr(GDBusObjectManagerServer) srcserverB =3D NULL; + g_autoptr(GDBusObjectManagerServer) dstserverA =3D NULL; + g_autoptr(GDBusObjectManagerServer) dstserverB =3D NULL; + g_auto(GStrv) srcaddr =3D NULL; + g_auto(GStrv) dstaddr =3D NULL; + g_autofree char *uri =3D NULL; + QTestState *src_qemu =3D NULL, *dst_qemu =3D NULL; + guint ownsrcA, ownsrcB, owndstA, owndstB; + + uri =3D g_strdup_printf("unix:%s/migsocket", workdir); + + test->loop =3D g_main_loop_new(NULL, TRUE); + + srcbus =3D g_test_dbus_new(G_TEST_DBUS_NONE); + g_test_dbus_up(srcbus); + srcconnA =3D get_connection(test, &ownsrcA); + srcserverA =3D get_server(srcconnA, &test->srcA, &idA); + srcconnB =3D get_connection(test, &ownsrcB); + srcserverB =3D get_server(srcconnB, &test->srcB, &idB); + + /* remove ,guid=3Dfoo part */ + srcaddr =3D g_strsplit(g_test_dbus_get_bus_address(srcbus), ",", 2); + src_qemu_args =3D + g_strdup_printf("-object dbus-vmstate,id=3Ddv,addr=3D%s", srcaddr[= 0]); + + dstbus =3D g_test_dbus_new(G_TEST_DBUS_NONE); + g_test_dbus_up(dstbus); + dstconnA =3D get_connection(test, &owndstA); + dstserverA =3D get_server(dstconnA, &test->dstA, &idA); + if (!test->without_dst_b) { + dstconnB =3D get_connection(test, &owndstB); + dstserverB =3D get_server(dstconnB, &test->dstB, &idB); + } + + dstaddr =3D g_strsplit(g_test_dbus_get_bus_address(dstbus), ",", 2); + dst_qemu_args =3D + g_strdup_printf("-object dbus-vmstate,id=3Ddv,addr=3D%s -incoming = %s", + dstaddr[0], uri); + + src_qemu =3D qtest_init(src_qemu_args); + dst_qemu =3D qtest_init(dst_qemu_args); + set_id_list(test, src_qemu); + set_id_list(test, dst_qemu); + + migrate(src_qemu, uri); + test->src_qemu =3D src_qemu; + g_timeout_add_seconds(1, wait_for_migration_complete, test); + + g_main_loop_run(test->loop); + g_main_loop_unref(test->loop); + + if (test->migrate_fail) { + qtest_set_expected_status(dst_qemu, 1); + } + qtest_quit(dst_qemu); + qtest_quit(src_qemu); + g_bus_unown_name(ownsrcA); + g_bus_unown_name(ownsrcB); + g_bus_unown_name(owndstA); + if (!test->without_dst_b) { + g_bus_unown_name(owndstB); + } +} + +static void +check_not_migrated(TestServer *s, TestServer *d) +{ + assert(!s->save_called); + assert(!s->load_called); + assert(!d->save_called); + assert(!d->load_called); +} + +static void +check_migrated(TestServer *s, TestServer *d) +{ + assert(s->save_called); + assert(!s->load_called); + assert(!d->save_called); + assert(d->load_called); +} + +static void +test_dbus_vmstate_without_list(void) +{ + Test test =3D { 0, }; + + test_dbus_vmstate(&test); + + check_migrated(&test.srcA, &test.dstA); + check_migrated(&test.srcB, &test.dstB); +} + +static void +test_dbus_vmstate_with_list(void) +{ + Test test =3D { .id_list =3D "idA,idB" }; + + test_dbus_vmstate(&test); + + check_migrated(&test.srcA, &test.dstA); + check_migrated(&test.srcB, &test.dstB); +} + +static void +test_dbus_vmstate_only_a(void) +{ + Test test =3D { .id_list =3D "idA" }; + + test_dbus_vmstate(&test); + + check_migrated(&test.srcA, &test.dstA); + check_not_migrated(&test.srcB, &test.dstB); +} + +static void +test_dbus_vmstate_missing_src(void) +{ + Test test =3D { .id_list =3D "idA,idC", .migrate_fail =3D true }; + + /* run in subprocess to silence QEMU error reporting */ + if (g_test_subprocess()) { + test_dbus_vmstate(&test); + check_not_migrated(&test.srcA, &test.dstA); + check_not_migrated(&test.srcB, &test.dstB); + return; + } + + g_test_trap_subprocess(NULL, 0, 0); + g_test_trap_assert_passed(); +} + +static void +test_dbus_vmstate_missing_dst(void) +{ + Test test =3D { .id_list =3D "idA,idB", + .without_dst_b =3D true, + .migrate_fail =3D true }; + + /* run in subprocess to silence QEMU error reporting */ + if (g_test_subprocess()) { + test_dbus_vmstate(&test); + assert(test.srcA.save_called); + assert(test.srcB.save_called); + assert(!test.dstB.save_called); + return; + } + + g_test_trap_subprocess(NULL, 0, 0); + g_test_trap_assert_passed(); +} + +int +main(int argc, char **argv) +{ + GError *err =3D NULL; + g_autofree char *dbus_daemon =3D NULL; + int ret; + + dbus_daemon =3D g_build_filename(G_STRINGIFY(SRCDIR), + "tests", + "dbus-vmstate-daemon.sh", + NULL); + g_setenv("G_TEST_DBUS_DAEMON", dbus_daemon, true); + + g_test_init(&argc, &argv, NULL); + + workdir =3D g_dir_make_tmp("dbus-vmstate-test-XXXXXX", &err); + if (!workdir) { + g_error("Unable to create temporary dir: %s\n", err->message); + exit(1); + } + + qtest_add_func("/dbus-vmstate/without-list", + test_dbus_vmstate_without_list); + qtest_add_func("/dbus-vmstate/with-list", + test_dbus_vmstate_with_list); + qtest_add_func("/dbus-vmstate/only-a", + test_dbus_vmstate_only_a); + qtest_add_func("/dbus-vmstate/missing-src", + test_dbus_vmstate_missing_src); + qtest_add_func("/dbus-vmstate/missing-dst", + test_dbus_vmstate_missing_dst); + + ret =3D g_test_run(); + + rmdir(workdir); + g_free(workdir); + + return ret; +} diff --git a/tests/dbus-vmstate1.xml b/tests/dbus-vmstate1.xml new file mode 100644 index 0000000000..cc8563be4c --- /dev/null +++ b/tests/dbus-vmstate1.xml @@ -0,0 +1,12 @@ + + + + + + + + + + + + --=20 2.23.0