Skip to contentSkip to conversation

libxl: replace deprecated -sdl and -soundhw qemu options

PATCH In review Anthony PERARD 2 participants 7 messages Aug 8, 2022 – Aug 16, 2022

lore
Share & tools
lore
#0 lore raw

cover libxl: replace deprecated -sdl and -soundhw qemu options

Patch series available in this git branch:
https://xenbits.xen.org/git-http/people/aperard/xen-unstable.git br.qemu-deprecated-soundhw-v1

Hi,

There's some more QEMU options that are deprecated. We still don't need to figure out which QEMU version we are going to run as the options that replace them already existed in QEMU 1.0, so all the version QEMU upstream that we could possible use as device model.

Thanks,

Anthony PERARD (2):
tools/libxl: Replace deprecated -sdl option on QEMU command line tools/libxl: Replace deprecated -soundhw on QEMU command line

 docs/man/xl.cfg.5.pod.in                  |  6 +++---
 tools/libs/light/libxl_types_internal.idl | 10 ++++++++++
 tools/libs/light/libxl_dm.c               | 21 +++++++++++++++++++--
 3 files changed, 32 insertions(+), 5 deletions(-)
Signature · 1 line
Anthony PERARD
#1 lore raw

PATCH 1/2 tools/libxl: Replace deprecated -sdl option on QEMU command line

"-sdl" is deprecated upstream since 6695e4c0fd9e ("softmmu/vl:
Deprecate the -sdl and -curses option"), QEMU v6.2, and the option is removed by 707d93d4abc6 ("ui: Remove deprecated options "-sdl" and "-curses""), in upcoming QEMU v7.1.

Instead, use "-display sdl", available since 1472a95bab1e ("Introduce -display argument"), before QEMU v1.0.

---
 tools/libs/light/libxl_dm.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/libs/light/libxl_dm.c +1 -1
index 1864ee30f0..04bf5d8563 100644
@@ -1349,7 +1349,7 @@ static int libxl__build_device_model_args_new(libxl__gc *gc,
     flexarray_append_pair(dm_args, "-display", "none");
 
     if (sdl && !is_stubdom) {
-        flexarray_append(dm_args, "-sdl");
+        flexarray_append_pair(dm_args, "-display", "sdl");
         if (sdl->display)
             flexarray_append_pair(dm_envs, "DISPLAY", sdl->display);
         if (sdl->xauthority)
Signature · 1 line
Anthony PERARD
Reviewed-by on v1 1/2
#2 lore raw

Re: [XEN PATCH 1/2] tools/libxl: Replace deprecated -sdl option on QEMU command line

Quoted 10 lines · Anthony PERARD

"-sdl" is deprecated upstream since 6695e4c0fd9e ("softmmu/vl:
Deprecate the -sdl and -curses option"), QEMU v6.2, and the option is removed by 707d93d4abc6 ("ui: Remove deprecated options "-sdl" and "-curses""), in upcoming QEMU v7.1.

Instead, use "-display sdl", available since 1472a95bab1e ("Introduce -display argument"), before QEMU v1.0.

#3 lore raw

PATCH 2/2 tools/libxl: Replace deprecated -soundhw on QEMU command line

In reply to Anthony PERARD

-soundhw is deprecated since 825ff02911c9 ("audio: add soundhw deprecation notice"), QEMU v5.1, and is been remove for upcoming v7.1 by 039a68373c45 ("introduce -audio as a replacement for -soundhw").

Instead we can just add the sound card with "-device", for most option that "-soundhw" could handle. "-device" is an option that existed before QEMU 1.0, and could already be used to add audio hardware.

The list of possible option for libxl's "soundhw" is taken the list from QEMU 7.0.

The list of options for "soundhw" are listed in order of preference in the manual. The first three (hda, ac97, es1370) are PCI devices and easy to test on Linux, and the last four are ISA devices which doesn't seems to work out of the box on linux.

The sound card 'pcspk' isn't listed even if it used to be accepted by '-soundhw' because QEMU crash when trying to add it to a Xen domain. Also, it wouldn't work with "-device" might need to be "-machine pcspk-audiodev=default" instead.

---
 docs/man/xl.cfg.5.pod.in                  |  6 +++---
 tools/libs/light/libxl_types_internal.idl | 10 ++++++++++
 tools/libs/light/libxl_dm.c               | 19 ++++++++++++++++++-
 3 files changed, 31 insertions(+), 4 deletions(-)
docs/man/xl.cfg.5.pod.in +3 -3
index 6d98d73d76..b2901e04cf 100644
@@ -2555,9 +2555,9 @@ The form serial=DEVICE is also accepted for backwards compatibility.
 
 =item B<soundhw="DEVICE">
 
-Select the virtual sound card to expose to the guest. The valid
-devices are defined by the device model configuration, please see the
-B<qemu(1)> manpage for details. The default is not to export any sound
+Select the virtual sound card to expose to the guest. The valid devices are
+B<hda>, B<ac97>, B<es1370>, B<adlib>, B<cs4231a>, B<gus>, B<sb16> if there are
+available with the device model QEMU. The default is not to export any sound
 device.
 
 =item B<vkb_device=BOOLEAN>
tools/libs/light/libxl_types_internal.idl +10 -0
index 8f71980aec..fb0f4f23d7 100644
@@ -56,3 +56,13 @@ libxl__device_action = Enumeration("device_action", [
     (1, "ADD"),
     (2, "REMOVE"),
     ])
+
+libxl__qemu_soundhw = Enumeration("qemu_soundhw", [
+    (1, "ac97"),
+    (2, "adlib"),
+    (3, "cs4231a"),
+    (4, "es1370"),
+    (5, "gus"),
+    (6, "hda"),
+    (7, "sb16"),
+    ])
tools/libs/light/libxl_dm.c +18 -1
index 04bf5d8563..fc264a3a13 100644
@@ -1204,6 +1204,7 @@ static int libxl__build_device_model_args_new(libxl__gc *gc,
     uint64_t ram_size;
     const char *path, *chardev;
     bool is_stubdom = libxl_defbool_val(b_info->device_model_stubdomain);
+    int rc;
 
     dm_args = flexarray_make(gc, 16, 1);
     dm_envs = flexarray_make(gc, 16, 1);
@@ -1531,7 +1532,23 @@ static int libxl__build_device_model_args_new(libxl__gc *gc,
             }
         }
         if (b_info->u.hvm.soundhw) {
-            flexarray_vappend(dm_args, "-soundhw", b_info->u.hvm.soundhw, NULL);
+            libxl__qemu_soundhw soundhw;
+
+            rc = libxl__qemu_soundhw_from_string(b_info->u.hvm.soundhw, &soundhw);
+            if (rc) {
+                LOGD(ERROR, guest_domid, "Unknown soundhw option '%s'", b_info->u.hvm.soundhw);
+                return ERROR_INVAL;
+            }
+
+            switch (soundhw) {
+            case LIBXL__QEMU_SOUNDHW_HDA:
+                flexarray_vappend(dm_args, "-device", "intel-hda",
+                                  "-device", "hda-duplex", NULL);
+                break;
+            default:
+                flexarray_append_pair(dm_args, "-device",
+                                      (char*)libxl__qemu_soundhw_to_string(soundhw));
+            }
         }
         if (!libxl__acpi_defbool_val(b_info)) {
             flexarray_append(dm_args, "-no-acpi");
Signature · 1 line
Anthony PERARD
Reviewed-by on v1 2/2
#4 lore raw

Re: [XEN PATCH 2/2] tools/libxl: Replace deprecated -soundhw on QEMU command line

Quoted 17 lines · Anthony PERARD

-soundhw is deprecated since 825ff02911c9 ("audio: add soundhw deprecation notice"), QEMU v5.1, and is been remove for upcoming v7.1 by 039a68373c45 ("introduce -audio as a replacement for -soundhw").

Instead we can just add the sound card with "-device", for most option that "-soundhw" could handle. "-device" is an option that existed before QEMU 1.0, and could already be used to add audio hardware.

The list of possible option for libxl's "soundhw" is taken the list from QEMU 7.0.

The list of options for "soundhw" are listed in order of preference in the manual. The first three (hda, ac97, es1370) are PCI devices and easy to test on Linux, and the last four are ISA devices which doesn't seems to work out of the box on linux.

Quoted 6 lines

The sound card 'pcspk' isn't listed even if it used to be accepted by '-soundhw' because QEMU crash when trying to add it to a Xen domain. Also, it wouldn't work with "-device" might need to be "-machine pcspk-audiodev=default" instead.

With one question below.

Quoted 11 lines
---
 docs/man/xl.cfg.5.pod.in                  |  6 +++---
 tools/libs/light/libxl_types_internal.idl | 10 ++++++++++
 tools/libs/light/libxl_dm.c               | 19 ++++++++++++++++++-
 3 files changed, 31 insertions(+), 4 deletions(-)
docs/man/xl.cfg.5.pod.in +0 -0
index 6d98d73d76..b2901e04cf 100644

docs/man/xl.cfg.5.pod.in The form serial=DEVICE is also accepted for backwards compatibility. · line 2561

Quoted 10 lines
docs/man/xl.cfg.5.pod.in +3 -3
@@ -2555,9 +2555,9 @@ The form serial=DEVICE is also accepted for backwards compatibility.
 
 =item B<soundhw="DEVICE">
 
-Select the virtual sound card to expose to the guest. The valid
-devices are defined by the device model configuration, please see the
-B<qemu(1)> manpage for details. The default is not to export any sound
+Select the virtual sound card to expose to the guest. The valid devices are
+B<hda>, B<ac97>, B<es1370>, B<adlib>, B<cs4231a>, B<gus>, B<sb16> if there are
+available with the device model QEMU. The default is not to export any sound
 device.

Is it worth mentioning driver support? I think Windows 7 and later only have a built-in driver for hda. Windows 7 definitely doesn't have a built-in driver for ac97. I think all the other devices are even older, so I doubt Windows has drivers for those, but I have not checked.

Regards,
Jason

#5 lore raw

Re: [XEN PATCH 2/2] tools/libxl: Replace deprecated -soundhw on QEMU command line

Quoted 9 lines · Jason Andryuk
Quoted 8 lines · Anthony PERARD
docs/man/xl.cfg.5.pod.in +0 -0
index 6d98d73d76..b2901e04cf 100644
@@ -2555,9 +2555,9 @@ The form serial=DEVICE is also accepted for backwards compatibility.
 
 =item B<soundhw="DEVICE">
 
Quoted 13 lines

docs/man/xl.cfg.5.pod.in The form serial=DEVICE is also accepted for backwards compatibility. · line 2561

Quoted 7 lines
docs/man/xl.cfg.5.pod.in +3 -3
-Select the virtual sound card to expose to the guest. The valid
-devices are defined by the device model configuration, please see the
-B<qemu(1)> manpage for details. The default is not to export any sound
+Select the virtual sound card to expose to the guest. The valid devices are
+B<hda>, B<ac97>, B<es1370>, B<adlib>, B<cs4231a>, B<gus>, B<sb16> if there are
+available with the device model QEMU. The default is not to export any sound
 device.

Is it worth mentioning driver support? I think Windows 7 and later only have a built-in driver for hda. Windows 7 definitely doesn't have a built-in driver for ac97. I think all the other devices are even older, so I doubt Windows has drivers for those, but I have not checked.

No, I don't think we can mention drivers support, we don't test any, it would be incomplete, and we can't do anything if a driver is broken. I've put "hda" first on the list in the hope that if someone wants a sound card but don't know which one to use, they will try this one first.

Thanks,

Signature · 1 line
Anthony PERARD
#6 lore raw

Re: [XEN PATCH 2/2] tools/libxl: Replace deprecated -soundhw on QEMU command line

Quoted 25 lines · Anthony PERARD
Quoted 9 lines · Jason Andryuk
Quoted 8 lines · Anthony PERARD
docs/man/xl.cfg.5.pod.in +0 -0
index 6d98d73d76..b2901e04cf 100644
@@ -2555,9 +2555,9 @@ The form serial=DEVICE is also accepted for backwards compatibility.
 
 =item B<soundhw="DEVICE">
 
Quoted 13 lines

docs/man/xl.cfg.5.pod.in The form serial=DEVICE is also accepted for backwards compatibility. · line 2561

Quoted 7 lines
docs/man/xl.cfg.5.pod.in +3 -3
-Select the virtual sound card to expose to the guest. The valid
-devices are defined by the device model configuration, please see the
-B<qemu(1)> manpage for details. The default is not to export any sound
+Select the virtual sound card to expose to the guest. The valid devices are
+B<hda>, B<ac97>, B<es1370>, B<adlib>, B<cs4231a>, B<gus>, B<sb16> if there are
+available with the device model QEMU. The default is not to export any sound
 device.

Is it worth mentioning driver support? I think Windows 7 and later only have a built-in driver for hda. Windows 7 definitely doesn't have a built-in driver for ac97. I think all the other devices are even older, so I doubt Windows has drivers for those, but I have not checked.

Quoted 5 lines

No, I don't think we can mention drivers support, we don't test any, it would be incomplete, and we can't do anything if a driver is broken. I've put "hda" first on the list in the hope that if someone wants a sound card but don't know which one to use, they will try this one first.

Ok. That sounds fine.

Thanks,
Jason