Skip to contentSkip to conversation

qom: Fix missing interface in qemu-storage-daemon

RFC PATCH Superseded Philippe Mathieu-Daudé 5 participants 9 messages Oct 5, 2020 – Oct 6, 2020 Arm/Amlogic Meson SoC support

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover qom: Fix missing interface in qemu-storage-daemon

Attempt to fix the issue reported by Kevin.

Introduce a trivial test, but there is currently no framework in place to test qemu-storage-daemon.

There might be better fix to this QOM issue,
I went for the easiest one I could figure out.

Philippe Mathieu-Daudé (3):
qom: Always register FW_CFG_DATA_GENERATOR_INTERFACE
tests: Only build socket_scm_helper when a softmmu target is available
tests: Add a trivial qemu-storage-daemon test

 hw/nvram/fw_cfg.c            |  7 -------
 qom/fw_cfg_interface.c       | 15 +++++++++++++++
 MAINTAINERS                  |  1 +
 qom/meson.build              |  5 +++++
 tests/Makefile.include       |  5 +++++
 tests/qemu-storage-daemon.sh | 10 ++++++++++
 6 files changed, 36 insertions(+), 7 deletions(-)
 create mode 100644 qom/fw_cfg_interface.c
 create mode 100755 tests/qemu-storage-daemon.sh
Signature · 1 line
2.26.2
#1 lore raw

RFC PATCH 1/3 qom: Always register FW_CFG_DATA_GENERATOR_INTERFACE

While the FW_CFG_DATA_GENERATOR_INTERFACE is only consumed by a device only available using system-mode (fw_cfg), it is implemented by a crypto component (tls-cipher-suites) which is always available when crypto is used.

Commit 69699f3055 introduced the following error in the qemu-storage-daemon binary:

  $ echo -e \
    '{"execute": "qmp_capabilities"}\r\n{"execute": "qom-list-types"}\r\n{"execute": "quit"}\r\n' \
    | storage-daemon/qemu-storage-daemon --chardev stdio,id=qmp0  --monitor qmp0
  {"QMP": {"version": {"qemu": {"micro": 50, "minor": 1, "major": 5}, "package": ""}, "capabilities": ["oob"]}}
  {"return": {}}
  missing interface 'fw_cfg-data-generator' for object 'tls-creds'
  Aborted (core dumped)

Since QOM dependencies are resolved at runtime, this issue could not be triggered at linktime, and we don't have test running the qemu-storage-daemon binary.

Fix by always registering the QOM interface.

Fixes 69699f3055 ("crypto/tls-cipher-suites: Produce fw_cfg consumable blob")

---
I first used:

+if config_host.has_key('CONFIG_GNUTLS') or have_system
+ qom_ss.add(files('fw_cfg_interface.c')) +endif

but then realized anything could implement a QOM interface, so better keep this generic.

---
 hw/nvram/fw_cfg.c      |  7 -------
 qom/fw_cfg_interface.c | 15 +++++++++++++++
 MAINTAINERS            |  1 +
 qom/meson.build        |  5 +++++
 4 files changed, 21 insertions(+), 7 deletions(-)
 create mode 100644 qom/fw_cfg_interface.c
hw/nvram/fw_cfg.c +0 -7
index 0e95d057fd..08539a1aab 100644
@@ -1360,18 +1360,11 @@ static const TypeInfo fw_cfg_mem_info = {
     .class_init    = fw_cfg_mem_class_init,
 };
 
-static const TypeInfo fw_cfg_data_generator_interface_info = {
-    .parent = TYPE_INTERFACE,
-    .name = TYPE_FW_CFG_DATA_GENERATOR_INTERFACE,
-    .class_size = sizeof(FWCfgDataGeneratorClass),
-};
-
 static void fw_cfg_register_types(void)
 {
     type_register_static(&fw_cfg_info);
     type_register_static(&fw_cfg_io_info);
     type_register_static(&fw_cfg_mem_info);
-    type_register_static(&fw_cfg_data_generator_interface_info);
 }
 
 type_init(fw_cfg_register_types)
qom/fw_cfg_interface.c new file +15 -0
new file mode 100644
index 0000000000..2b19502ffe
@@ -0,0 +1,15 @@
+#include "qemu/osdep.h"
+#include "hw/nvram/fw_cfg.h"
+
+static const TypeInfo fw_cfg_data_generator_interface_info = {
+    .parent = TYPE_INTERFACE,
+    .name = TYPE_FW_CFG_DATA_GENERATOR_INTERFACE,
+    .class_size = sizeof(FWCfgDataGeneratorClass),
+};
+
+static void fw_cfg_register_types(void)
+{
+    type_register_static(&fw_cfg_data_generator_interface_info);
+}
+
+type_init(fw_cfg_register_types)
MAINTAINERS +1 -0
index b76fb31861..9c89d54b41 100644
@@ -2055,6 +2055,7 @@ R: Gerd Hoffmann <[email protected]>
 S: Supported
 F: docs/specs/fw_cfg.txt
 F: hw/nvram/fw_cfg.c
+F: qom/fw_cfg_interface.c
 F: stubs/fw_cfg.c
 F: include/hw/nvram/fw_cfg.h
 F: include/standard-headers/linux/qemu_fw_cfg.h
qom/meson.build +5 -0
index a1cd03c82c..7335f8c8a2 100644
@@ -7,6 +7,11 @@ qom_ss.add(files(
   'qom-qobject.c',
 ))
 
+# interfaces any object might implement
+qom_ss.add(files(
+  'fw_cfg_interface.c',
+))
+
 qmp_ss.add(files('qom-qmp-cmds.c'))
 softmmu_ss.add(files('qom-hmp-cmds.c'))
 
Signature · 1 line
2.26.2
#2 lore raw

Re: [RFC PATCH 1/3] qom: Always register FW_CFG_DATA_GENERATOR_INTERFACE

Quoted 32 lines · Philippe Mathieu-Daudé

While the FW_CFG_DATA_GENERATOR_INTERFACE is only consumed by a device only available using system-mode (fw_cfg), it is implemented by a crypto component (tls-cipher-suites) which is always available when crypto is used.

Commit 69699f3055 introduced the following error in the qemu-storage-daemon binary:

  $ echo -e \
    '{"execute": "qmp_capabilities"}\r\n{"execute": "qom-list-types"}\r\n{"execute": "quit"}\r\n' \
    | storage-daemon/qemu-storage-daemon --chardev stdio,id=qmp0  --monitor qmp0
  {"QMP": {"version": {"qemu": {"micro": 50, "minor": 1, "major": 5}, "package": ""}, "capabilities": ["oob"]}}
  {"return": {}}
  missing interface 'fw_cfg-data-generator' for object 'tls-creds'
  Aborted (core dumped)

Since QOM dependencies are resolved at runtime, this issue could not be triggered at linktime, and we don't have test running the qemu-storage-daemon binary.

Fix by always registering the QOM interface.

Fixes 69699f3055 ("crypto/tls-cipher-suites: Produce fw_cfg consumable blob")

---
I first used:

(quoted diff) +3 -0
+if config_host.has_key('CONFIG_GNUTLS') or have_system
+  qom_ss.add(files('fw_cfg_interface.c'))
+endif
Quoted 5 lines

but then realized anything could implement a QOM interface, so better keep this generic.

---
 hw/nvram/fw_cfg.c      |  7 -------
 qom/fw_cfg_interface.c | 15 +++++++++++++++

I feel this should be left in hw/nvram, but still added to qom_ss.

The code location should reflect the functional area and maintainership, so we shouldn't move code just to satisfy linkage problems.

Quoted 80 lines
 MAINTAINERS            |  1 +
 qom/meson.build        |  5 +++++
 4 files changed, 21 insertions(+), 7 deletions(-)
 create mode 100644 qom/fw_cfg_interface.c
hw/nvram/fw_cfg.c +0 -7
index 0e95d057fd..08539a1aab 100644
@@ -1360,18 +1360,11 @@ static const TypeInfo fw_cfg_mem_info = {
     .class_init    = fw_cfg_mem_class_init,
 };
 
-static const TypeInfo fw_cfg_data_generator_interface_info = {
-    .parent = TYPE_INTERFACE,
-    .name = TYPE_FW_CFG_DATA_GENERATOR_INTERFACE,
-    .class_size = sizeof(FWCfgDataGeneratorClass),
-};
-
 static void fw_cfg_register_types(void)
 {
     type_register_static(&fw_cfg_info);
     type_register_static(&fw_cfg_io_info);
     type_register_static(&fw_cfg_mem_info);
-    type_register_static(&fw_cfg_data_generator_interface_info);
 }
 
 type_init(fw_cfg_register_types)
qom/fw_cfg_interface.c new file +15 -0
new file mode 100644
index 0000000000..2b19502ffe
@@ -0,0 +1,15 @@
+#include "qemu/osdep.h"
+#include "hw/nvram/fw_cfg.h"
+
+static const TypeInfo fw_cfg_data_generator_interface_info = {
+    .parent = TYPE_INTERFACE,
+    .name = TYPE_FW_CFG_DATA_GENERATOR_INTERFACE,
+    .class_size = sizeof(FWCfgDataGeneratorClass),
+};
+
+static void fw_cfg_register_types(void)
+{
+    type_register_static(&fw_cfg_data_generator_interface_info);
+}
+
+type_init(fw_cfg_register_types)
MAINTAINERS +1 -0
index b76fb31861..9c89d54b41 100644
@@ -2055,6 +2055,7 @@ R: Gerd Hoffmann <[email protected]>
 S: Supported
 F: docs/specs/fw_cfg.txt
 F: hw/nvram/fw_cfg.c
+F: qom/fw_cfg_interface.c
 F: stubs/fw_cfg.c
 F: include/hw/nvram/fw_cfg.h
 F: include/standard-headers/linux/qemu_fw_cfg.h
qom/meson.build +5 -0
index a1cd03c82c..7335f8c8a2 100644
@@ -7,6 +7,11 @@ qom_ss.add(files(
   'qom-qobject.c',
 ))
 
+# interfaces any object might implement
+qom_ss.add(files(
+  'fw_cfg_interface.c',
+))
+
 qmp_ss.add(files('qom-qmp-cmds.c'))
 softmmu_ss.add(files('qom-hmp-cmds.c'))
 
Signature · 1 line
2.26.2

Regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#3 lore raw

Re: [RFC PATCH 1/3] qom: Always register FW_CFG_DATA_GENERATOR_INTERFACE

Quoted 41 lines · Daniel P. Berrangé
Quoted 32 lines · Philippe Mathieu-Daudé

While the FW_CFG_DATA_GENERATOR_INTERFACE is only consumed by a device only available using system-mode (fw_cfg), it is implemented by a crypto component (tls-cipher-suites) which is always available when crypto is used.

Commit 69699f3055 introduced the following error in the qemu-storage-daemon binary:

  $ echo -e \
    '{"execute": "qmp_capabilities"}\r\n{"execute": "qom-list-types"}\r\n{"execute": "quit"}\r\n' \
    | storage-daemon/qemu-storage-daemon --chardev stdio,id=qmp0  --monitor qmp0
  {"QMP": {"version": {"qemu": {"micro": 50, "minor": 1, "major": 5}, "package": ""}, "capabilities": ["oob"]}}
  {"return": {}}
  missing interface 'fw_cfg-data-generator' for object 'tls-creds'
  Aborted (core dumped)

Since QOM dependencies are resolved at runtime, this issue could not be triggered at linktime, and we don't have test running the qemu-storage-daemon binary.

Fix by always registering the QOM interface.

Fixes 69699f3055 ("crypto/tls-cipher-suites: Produce fw_cfg consumable blob")

---
I first used:

(quoted diff) +3 -0
+if config_host.has_key('CONFIG_GNUTLS') or have_system
+  qom_ss.add(files('fw_cfg_interface.c'))
+endif
Quoted 5 lines

but then realized anything could implement a QOM interface, so better keep this generic.

---
 hw/nvram/fw_cfg.c      |  7 -------
 qom/fw_cfg_interface.c | 15 +++++++++++++++

I feel this should be left in hw/nvram, but still added to qom_ss.

Quoted 2 lines

The code location should reflect the functional area and maintainership, so we shouldn't move code just to satisfy linkage problems.

I thought Meson would conditionally include subdir() meson.build like the Makefile based previous buildsys, but I was wrong, all subdir are processed.
I'll respin with your suggestion, thanks.

Phil.

#4 lore raw

Re: [RFC PATCH 1/3] qom: Always register FW_CFG_DATA_GENERATOR_INTERFACE

In reply to Philippe Mathieu-Daudé
Quoted 16 lines · Philippe Mathieu-Daudé

While the FW_CFG_DATA_GENERATOR_INTERFACE is only consumed by a device only available using system-mode (fw_cfg), it is implemented by a crypto component (tls-cipher-suites) which is always available when crypto is used.

Commit 69699f3055 introduced the following error in the qemu-storage-daemon binary:

  $ echo -e \
    '{"execute": "qmp_capabilities"}\r\n{"execute": "qom-list-types"}\r\n{"execute": "quit"}\r\n' \
    | storage-daemon/qemu-storage-daemon --chardev stdio,id=qmp0  --monitor qmp0
  {"QMP": {"version": {"qemu": {"micro": 50, "minor": 1, "major": 5}, "package": ""}, "capabilities": ["oob"]}}
  {"return": {}}
  missing interface 'fw_cfg-data-generator' for object 'tls-creds'
  Aborted (core dumped)
Quoted 2 lines

Since QOM dependencies are resolved at runtime, this issue could not be triggered at linktime,

O_o

I'll defer the review of this work to others with actual QOM knowledge.

Please ping me when the series is otherwise ready; I'll be happy to ACK the fw_cfg parts (if any).

Laszlo

Quoted 98 lines

and we don't have test
running the qemu-storage-daemon binary.

Fix by always registering the QOM interface.

Fixes 69699f3055 ("crypto/tls-cipher-suites: Produce fw_cfg consumable blob")

---
I first used:

(quoted diff) +3 -0
+if config_host.has_key('CONFIG_GNUTLS') or have_system
+  qom_ss.add(files('fw_cfg_interface.c'))
+endif

but then realized anything could implement a QOM interface, so better keep this generic.

---
 hw/nvram/fw_cfg.c      |  7 -------
 qom/fw_cfg_interface.c | 15 +++++++++++++++
 MAINTAINERS            |  1 +
 qom/meson.build        |  5 +++++
 4 files changed, 21 insertions(+), 7 deletions(-)
 create mode 100644 qom/fw_cfg_interface.c
hw/nvram/fw_cfg.c +0 -7
index 0e95d057fd..08539a1aab 100644
@@ -1360,18 +1360,11 @@ static const TypeInfo fw_cfg_mem_info = {
     .class_init    = fw_cfg_mem_class_init,
 };
 
-static const TypeInfo fw_cfg_data_generator_interface_info = {
-    .parent = TYPE_INTERFACE,
-    .name = TYPE_FW_CFG_DATA_GENERATOR_INTERFACE,
-    .class_size = sizeof(FWCfgDataGeneratorClass),
-};
-
 static void fw_cfg_register_types(void)
 {
     type_register_static(&fw_cfg_info);
     type_register_static(&fw_cfg_io_info);
     type_register_static(&fw_cfg_mem_info);
-    type_register_static(&fw_cfg_data_generator_interface_info);
 }
 
 type_init(fw_cfg_register_types)
qom/fw_cfg_interface.c new file +15 -0
new file mode 100644
index 0000000000..2b19502ffe
@@ -0,0 +1,15 @@
+#include "qemu/osdep.h"
+#include "hw/nvram/fw_cfg.h"
+
+static const TypeInfo fw_cfg_data_generator_interface_info = {
+    .parent = TYPE_INTERFACE,
+    .name = TYPE_FW_CFG_DATA_GENERATOR_INTERFACE,
+    .class_size = sizeof(FWCfgDataGeneratorClass),
+};
+
+static void fw_cfg_register_types(void)
+{
+    type_register_static(&fw_cfg_data_generator_interface_info);
+}
+
+type_init(fw_cfg_register_types)
MAINTAINERS +1 -0
index b76fb31861..9c89d54b41 100644
@@ -2055,6 +2055,7 @@ R: Gerd Hoffmann <[email protected]>
 S: Supported
 F: docs/specs/fw_cfg.txt
 F: hw/nvram/fw_cfg.c
+F: qom/fw_cfg_interface.c
 F: stubs/fw_cfg.c
 F: include/hw/nvram/fw_cfg.h
 F: include/standard-headers/linux/qemu_fw_cfg.h
qom/meson.build +5 -0
index a1cd03c82c..7335f8c8a2 100644
@@ -7,6 +7,11 @@ qom_ss.add(files(
   'qom-qobject.c',
 ))
 
+# interfaces any object might implement
+qom_ss.add(files(
+  'fw_cfg_interface.c',
+))
+
 qmp_ss.add(files('qom-qmp-cmds.c'))
 softmmu_ss.add(files('qom-hmp-cmds.c'))
 
#5 lore raw

RFC PATCH 2/3 tests: Only build socket_scm_helper when a softmmu target is available

In reply to Philippe Mathieu-Daudé

Do not try to build socket_scm_helper if not softmmu target is available. This fixes:

  $ make check-block
  Generating qemu-version.h with a meson_exe.py custom command
  make: *** No rule to make target 'tests/qemu-iotests/socket_scm_helper', needed by 'check-block'.  Stop.
---
 tests/Makefile.include | 2 ++
 1 file changed, 2 insertions(+)
tests/Makefile.include +2 -0
index 40d909badc..d257777560 100644
@@ -136,7 +136,9 @@ check-acceptance: check-venv $(TESTS_RESULTS_DIR) get-vm-images
 check:
 
 ifeq ($(CONFIG_TOOLS)$(CONFIG_POSIX),yy)
+ifneq ($(TARGET_DIRS),)
 QEMU_IOTESTS_HELPERS-$(CONFIG_LINUX) = tests/qemu-iotests/socket_scm_helper$(EXESUF)
+endif
 check: check-block
 check-block: $(SRC_PATH)/tests/check-block.sh qemu-img$(EXESUF) \
 		qemu-io$(EXESUF) qemu-nbd$(EXESUF) $(QEMU_IOTESTS_HELPERS-y) \
Signature · 1 line
2.26.2
#6 lore raw

RFC PATCH 3/3 tests: Add a trivial qemu-storage-daemon test

In reply to Philippe Mathieu-Daudé

This test fails on top of commit 69699f3055 ("crypto/tls-cipher-suites: Produce fw_cfg consumable blob") because the TYPE_FW_CFG_DATA_GENERATOR_INTERFACE registered in hw/nvram/fw_cfg.c is not linked into qemu-storage-daemon:

  $ make check-block
  Generating qemu-version.h with a meson_exe.py custom command
    qemu-storage-daemon
  tests/qemu-storage-daemon.sh: line 10: 2089929 Aborted                 (core dumped)
---
 tests/Makefile.include       |  3 +++
 tests/qemu-storage-daemon.sh | 10 ++++++++++
 2 files changed, 13 insertions(+)
 create mode 100755 tests/qemu-storage-daemon.sh
tests/Makefile.include +3 -0
index d257777560..be12581c77 100644
@@ -142,7 +142,10 @@ endif
 check: check-block
 check-block: $(SRC_PATH)/tests/check-block.sh qemu-img$(EXESUF) \
 		qemu-io$(EXESUF) qemu-nbd$(EXESUF) $(QEMU_IOTESTS_HELPERS-y) \
+		storage-daemon/qemu-storage-daemon \
 		$(patsubst %-softmmu,qemu-system-%,$(filter %-softmmu,$(TARGET_DIRS)))
+	$(call quiet-command, \
+			$(SRC_PATH)/tests/qemu-storage-daemon.sh, "qemu-storage-daemon")
 	@$<
 endif
 
tests/qemu-storage-daemon.sh new file +10 -0
new file mode 100755
index 0000000000..9fd4c73400
@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# Test all QOM dependencies are resolved
+storage-daemon/qemu-storage-daemon \
+  --chardev stdio,id=qmp0  --monitor qmp0 \
+  > /dev/null << 'EOF'
+{"execute": "qmp_capabilities"}
+{"execute": "qom-list-types"}
+{"execute": "quit"}
+EOF
Signature · 1 line
2.26.2
#7 lore raw

Re: [RFC PATCH 3/3] tests: Add a trivial qemu-storage-daemon test

Quoted 38 lines · Philippe Mathieu-Daudé

This test fails on top of commit 69699f3055 ("crypto/tls-cipher-suites: Produce fw_cfg consumable blob") because the TYPE_FW_CFG_DATA_GENERATOR_INTERFACE registered in hw/nvram/fw_cfg.c is not linked into qemu-storage-daemon:

  $ make check-block
  Generating qemu-version.h with a meson_exe.py custom command
    qemu-storage-daemon
  tests/qemu-storage-daemon.sh: line 10: 2089929 Aborted                 (core dumped)
---
 tests/Makefile.include       |  3 +++
 tests/qemu-storage-daemon.sh | 10 ++++++++++
 2 files changed, 13 insertions(+)
 create mode 100755 tests/qemu-storage-daemon.sh
tests/Makefile.include +3 -0
index d257777560..be12581c77 100644
@@ -142,7 +142,10 @@ endif
 check: check-block
 check-block: $(SRC_PATH)/tests/check-block.sh qemu-img$(EXESUF) \
 		qemu-io$(EXESUF) qemu-nbd$(EXESUF) $(QEMU_IOTESTS_HELPERS-y) \
+		storage-daemon/qemu-storage-daemon \
 		$(patsubst %-softmmu,qemu-system-%,$(filter %-softmmu,$(TARGET_DIRS)))
+	$(call quiet-command, \
+			$(SRC_PATH)/tests/qemu-storage-daemon.sh, "qemu-storage-daemon")
 	@$<
 endif
 
tests/qemu-storage-daemon.sh new file +0 -0
new file mode 100755
index 0000000000..9fd4c73400

tests/qemu-storage-daemon.sh line 10

Quoted 10 lines
tests/qemu-storage-daemon.sh new file +10 -0
@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# Test all QOM dependencies are resolved
+storage-daemon/qemu-storage-daemon \
+  --chardev stdio,id=qmp0  --monitor qmp0 \
+  > /dev/null << 'EOF'
+{"execute": "qmp_capabilities"}
+{"execute": "qom-list-types"}
+{"execute": "quit"}
+EOF

I think you should either do this as a qemu-iotests testcase, or use libqtest.

Paolo

#8 lore raw
In reply to Philippe Mathieu-Daudé
Patchew URL: https://patchew.org/QEMU/[email protected]/

Patchew URL: https://patchew.org/QEMU/[email protected]/

Hi,

This series failed build test on FreeBSD host. Please find the details below.

=== TEST SCRIPT BEGIN ===
#!/bin/bash
# Testing script will be invoked under the git checkout with # HEAD pointing to a commit that has the patches applied on top of "base"

# branch
if qemu-system-x86_64 --help >/dev/null 2>&1; then
  QEMU=qemu-system-x86_64
elif /usr/libexec/qemu-kvm --help >/dev/null 2>&1; then
  QEMU=/usr/libexec/qemu-kvm
else
  exit 1
fi
make vm-build-freebsd J=21 QEMU=$QEMU
exit 0
=== TEST SCRIPT END ===

The full log is available at
http://patchew.org/logs/[email protected]/testing.FreeBSD/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to [email protected]