Skip to contentSkip to conversation

hw: report invalid disable-legacy|modern usage for virtio-1-only devs

PATCH Superseded Daniel P. Berrangé 3 participants 5 messages Jan 18, 2019 – Feb 15, 2019

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 hw: report invalid disable-legacy|modern usage for virtio-1-only devs

A number of virtio devices (gpu, crypto, mouse, keyboard, tablet) only support the virtio-1 (aka modern) mode. Currently if the user launches QEMU, setting those devices to enable legacy mode, QEMU will silently create them in modern mode, ignoring the user's (mistaken) request.

This patch introduces proper data validation so that an attempt to configure a virtio-1-only devices in legacy mode gets reported as an error to the user.

Checking this required introduction of a new field to explicitly track what operating model is to be used for a device, separately from the disable_modern and disable_legacy fields that record the user's requested configuration.

---
 hw/display/virtio-gpu-pci.c   |  4 +++-
 hw/display/virtio-vga.c       |  4 +++-
 hw/virtio/virtio-crypto-pci.c |  4 +++-
 hw/virtio/virtio-pci.c        | 30 +++++++++++++++++++-----------
 hw/virtio/virtio-pci.h        | 31 +++++++++++++++++++++++++------
 5 files changed, 53 insertions(+), 20 deletions(-)
hw/display/virtio-gpu-pci.c +3 -1
index faf76a8bc4..a5b5ce5755 100644
@@ -33,7 +33,9 @@ static void virtio_gpu_pci_realize(VirtIOPCIProxy *vpci_dev, Error **errp)
     Error *local_error = NULL;
 
     qdev_set_parent_bus(vdev, BUS(&vpci_dev->bus));
-    virtio_pci_force_virtio_1(vpci_dev);
+    if (!virtio_pci_force_virtio_1(vpci_dev, errp)) {
+        return;
+    }
     object_property_set_bool(OBJECT(vdev), true, "realized", &local_error);
 
     if (local_error) {
hw/display/virtio-vga.c +3 -1
index 8db4d916f2..ae3604c576 100644
@@ -144,7 +144,9 @@ static void virtio_vga_realize(VirtIOPCIProxy *vpci_dev, Error **errp)
 
     /* init virtio bits */
     qdev_set_parent_bus(DEVICE(g), BUS(&vpci_dev->bus));
-    virtio_pci_force_virtio_1(vpci_dev);
+    if (!virtio_pci_force_virtio_1(vpci_dev, errp)) {
+        return;
+    }
     object_property_set_bool(OBJECT(g), true, "realized", &err);
     if (err) {
         error_propagate(errp, err);
hw/virtio/virtio-crypto-pci.c +3 -1
index 8cc3fa3ef7..177b720458 100644
@@ -37,7 +37,9 @@ static void virtio_crypto_pci_realize(VirtIOPCIProxy *vpci_dev, Error **errp)
     }
 
     qdev_set_parent_bus(vdev, BUS(&vpci_dev->bus));
-    virtio_pci_force_virtio_1(vpci_dev);
+    if (!virtio_pci_force_virtio_1(vpci_dev, errp)) {
+        return;
+    }
     object_property_set_bool(OBJECT(vdev), true, "realized", errp);
     object_property_set_link(OBJECT(vcrypto),
                  OBJECT(vcrypto->vdev.conf.cryptodev), "cryptodev",
hw/virtio/virtio-pci.c +19 -11
index d05066deb8..75fdee40a8 100644
@@ -1778,16 +1778,22 @@ static void virtio_pci_realize(PCIDevice *pci_dev, Error **errp)
                        /* PCI BAR regions must be powers of 2 */
                        pow2ceil(proxy->notify.offset + proxy->notify.size));
 
-    if (proxy->disable_legacy == ON_OFF_AUTO_AUTO) {
-        proxy->disable_legacy = pcie_port ? ON_OFF_AUTO_ON : ON_OFF_AUTO_OFF;
-    }
-
-    if (!virtio_pci_modern(proxy) && !virtio_pci_legacy(proxy)) {
-        error_setg(errp, "device cannot work as neither modern nor legacy mode"
-                   " is enabled");
-        error_append_hint(errp, "Set either disable-modern or disable-legacy"
-                          " to off\n");
-        return;
+    if ((proxy->disable_legacy == ON_OFF_AUTO_ON) ||
+        ((proxy->disable_legacy == ON_OFF_AUTO_AUTO) && pcie_port)) {
+        if (proxy->disable_modern) {
+            error_setg(errp, "device cannot work as neither modern nor "
+                       "legacy mode is enabled");
+            error_append_hint(errp, "Set either disable-modern or "
+                              "disable-legacy to off\n");
+            return;
+        }
+        proxy->mode = VIRTIO_PCI_MODE_MODERN;
+    } else {
+        if (proxy->disable_modern) {
+            proxy->mode = VIRTIO_PCI_MODE_LEGACY;
+        } else {
+            proxy->mode = VIRTIO_PCI_MODE_TRANSITIONAL;
+        }
     }
 
     if (pcie_port && pci_is_express(pci_dev)) {
@@ -2663,7 +2669,9 @@ static void virtio_input_pci_realize(VirtIOPCIProxy *vpci_dev, Error **errp)
     DeviceState *vdev = DEVICE(&vinput->vdev);
 
     qdev_set_parent_bus(vdev, BUS(&vpci_dev->bus));
-    virtio_pci_force_virtio_1(vpci_dev);
+    if (!virtio_pci_force_virtio_1(vpci_dev, errp)) {
+        return;
+    }
     object_property_set_bool(OBJECT(vdev), true, "realized", errp);
 }
 
hw/virtio/virtio-pci.h +25 -6
index 29b4216107..d21c382702 100644
@@ -15,6 +15,7 @@
 #ifndef QEMU_VIRTIO_PCI_H
 #define QEMU_VIRTIO_PCI_H
 
+#include "qapi/error.h"
 #include "hw/pci/msi.h"
 #include "hw/virtio/virtio-blk.h"
 #include "hw/virtio/virtio-net.h"
@@ -156,6 +157,12 @@ typedef struct VirtIOPCIQueue {
   uint32_t used[2];
 } VirtIOPCIQueue;
 
+typedef enum {
+    VIRTIO_PCI_MODE_LEGACY,
+    VIRTIO_PCI_MODE_TRANSITIONAL,
+    VIRTIO_PCI_MODE_MODERN,
+} VirtIOPCIMode;
+
 struct VirtIOPCIProxy {
     PCIDevice pci_dev;
     MemoryRegion bar;
@@ -180,6 +187,7 @@ struct VirtIOPCIProxy {
     bool disable_modern;
     bool ignore_backend_features;
     OnOffAuto disable_legacy;
+    VirtIOPCIMode mode;
     uint32_t class_code;
     uint32_t nvectors;
     uint32_t dfselect;
@@ -194,23 +202,34 @@ struct VirtIOPCIProxy {
 
 static inline bool virtio_pci_modern(VirtIOPCIProxy *proxy)
 {
-    return !proxy->disable_modern;
+    return proxy->mode != VIRTIO_PCI_MODE_LEGACY;
 }
 
 static inline bool virtio_pci_legacy(VirtIOPCIProxy *proxy)
 {
-    return proxy->disable_legacy == ON_OFF_AUTO_OFF;
+    return proxy->mode != VIRTIO_PCI_MODE_MODERN;
 }
 
-static inline void virtio_pci_force_virtio_1(VirtIOPCIProxy *proxy)
+static inline bool virtio_pci_force_virtio_1(VirtIOPCIProxy *proxy,
+                                             Error **errp)
 {
-    proxy->disable_modern = false;
-    proxy->disable_legacy = ON_OFF_AUTO_ON;
+    if (proxy->disable_legacy == ON_OFF_AUTO_OFF) {
+        error_setg(errp, "Unable to set disable-legacy=off on a virtio-1.0 "
+                   "only device");
+        return false;
+    }
+    if (proxy->disable_modern == true) {
+        error_setg(errp, "Unable to set disable-modern=on on a virtio-1.0 "
+                   "only device");
+        return false;
+    }
+    proxy->mode = VIRTIO_PCI_MODE_MODERN;
+    return true;
 }
 
 static inline void virtio_pci_disable_modern(VirtIOPCIProxy *proxy)
 {
-    proxy->disable_modern = true;
+    proxy->mode = VIRTIO_PCI_MODE_LEGACY;
 }
 
 /*
Signature · 1 line
2.20.1
#1 lore raw
Quoted 9 lines · Daniel P. Berrangé

A number of virtio devices (gpu, crypto, mouse, keyboard, tablet) only support the virtio-1 (aka modern) mode. Currently if the user launches QEMU, setting those devices to enable legacy mode, QEMU will silently create them in modern mode, ignoring the user's (mistaken) request.

This patch introduces proper data validation so that an attempt to configure a virtio-1-only devices in legacy mode gets reported as an error to the user.

Quoted 6 lines

Checking this required introduction of a new field to explicitly track what operating model is to be used for a device, separately from the disable_modern and disable_legacy fields that record the user's requested configuration.

This breaks the virtio-1-only devices on pc-*-2.6:

  $ ./x86_64-softmmu/qemu-system-x86_64 -device virtio-vga -machine pc-i440fx-2.6
  qemu-system-x86_64: -device virtio-vga: Unable to set disable-legacy=off on a virtio-1.0 only device

Probably the simplest way to fix that is to append the following to hw_compat_2_6:

  { virtio-vga,        disable-modern, off },
  { virtio-gpu-pci,    disable-modern, off },
  { virtio-input-pci,  disable-modern, off },

{ virtio-crypto-pci, disable-modern, off }

We could also remove the property completely from those devices (e.g. by moving virtio-vga to virtio_vga_info.non_transitional_name), but it would break compatibility in case people are explicitly setting "disable-modern=off" on those devices.

Signature · 1 line
Eduardo
#2 lore raw
Quoted 22 lines · Eduardo Habkost
Quoted 9 lines · Daniel P. Berrangé

A number of virtio devices (gpu, crypto, mouse, keyboard, tablet) only support the virtio-1 (aka modern) mode. Currently if the user launches QEMU, setting those devices to enable legacy mode, QEMU will silently create them in modern mode, ignoring the user's (mistaken) request.

This patch introduces proper data validation so that an attempt to configure a virtio-1-only devices in legacy mode gets reported as an error to the user.

Quoted 6 lines

Checking this required introduction of a new field to explicitly track what operating model is to be used for a device, separately from the disable_modern and disable_legacy fields that record the user's requested configuration.

This breaks the virtio-1-only devices on pc-*-2.6:

  $ ./x86_64-softmmu/qemu-system-x86_64 -device virtio-vga -machine pc-i440fx-2.6
  qemu-system-x86_64: -device virtio-vga: Unable to set disable-legacy=off on a virtio-1.0 only device
Quoted 7 lines

Probably the simplest way to fix that is to append the following to hw_compat_2_6:

  { virtio-vga,        disable-modern, off },
  { virtio-gpu-pci,    disable-modern, off },
  { virtio-input-pci,  disable-modern, off },

{ virtio-crypto-pci, disable-modern, off }

Daniel do you plan to take a stub at this approach?

Quoted 7 lines

We could also remove the property completely from those devices (e.g. by moving virtio-vga to virtio_vga_info.non_transitional_name), but it would break compatibility in case people are explicitly setting "disable-modern=off" on those devices.

Signature · 1 line
Eduardo
#3 lore raw
Quoted 26 lines · Michael S. Tsirkin
Quoted 25 lines · Eduardo Habkost
Quoted 9 lines · Daniel P. Berrangé

A number of virtio devices (gpu, crypto, mouse, keyboard, tablet) only support the virtio-1 (aka modern) mode. Currently if the user launches QEMU, setting those devices to enable legacy mode, QEMU will silently create them in modern mode, ignoring the user's (mistaken) request.

This patch introduces proper data validation so that an attempt to configure a virtio-1-only devices in legacy mode gets reported as an error to the user.

Quoted 6 lines

Checking this required introduction of a new field to explicitly track what operating model is to be used for a device, separately from the disable_modern and disable_legacy fields that record the user's requested configuration.

This breaks the virtio-1-only devices on pc-*-2.6:

  $ ./x86_64-softmmu/qemu-system-x86_64 -device virtio-vga -machine pc-i440fx-2.6
  qemu-system-x86_64: -device virtio-vga: Unable to set disable-legacy=off on a virtio-1.0 only device

Probably the simplest way to fix that is to append the following to hw_compat_2_6:

Quoted 6 lines
Quoted 4 lines
  { virtio-vga,        disable-modern, off },
  { virtio-gpu-pci,    disable-modern, off },
  { virtio-input-pci,  disable-modern, off },

{ virtio-crypto-pci, disable-modern, off }

Daniel do you plan to take a stub at this approach?

Yes, its on my todo list, just haven't got to it yet

Quoted 8 lines
Quoted 8 lines

We could also remove the property completely from those devices (e.g. by moving virtio-vga to virtio_vga_info.non_transitional_name), but it would break compatibility in case people are explicitly setting "disable-modern=off" on those devices.

Signature · 1 line
Eduardo

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 :|
#4 lore raw
In reply to Eduardo Habkost
Quoted 22 lines · Eduardo Habkost
Quoted 9 lines · Daniel P. Berrangé

A number of virtio devices (gpu, crypto, mouse, keyboard, tablet) only support the virtio-1 (aka modern) mode. Currently if the user launches QEMU, setting those devices to enable legacy mode, QEMU will silently create them in modern mode, ignoring the user's (mistaken) request.

This patch introduces proper data validation so that an attempt to configure a virtio-1-only devices in legacy mode gets reported as an error to the user.

Quoted 6 lines

Checking this required introduction of a new field to explicitly track what operating model is to be used for a device, separately from the disable_modern and disable_legacy fields that record the user's requested configuration.

This breaks the virtio-1-only devices on pc-*-2.6:

  $ ./x86_64-softmmu/qemu-system-x86_64 -device virtio-vga -machine pc-i440fx-2.6
  qemu-system-x86_64: -device virtio-vga: Unable to set disable-legacy=off on a virtio-1.0 only device
Quoted 7 lines

Probably the simplest way to fix that is to append the following to hw_compat_2_6:

  { virtio-vga,        disable-modern, off },
  { virtio-gpu-pci,    disable-modern, off },
  { virtio-input-pci,  disable-modern, off },

{ virtio-crypto-pci, disable-modern, off }

That's no sufficient, as it needs to also set disable-legacy=on

Once we add all these extra properties, it becomes pointless to try to use the generic settings against virtio-pci in hw_compat_2_6. So I've just turn it into a whitelist, only listing the devices which actually support both modern+legacy modes. This makes it obvious which devices are being affected & avoids silent surprises like this bug you found in my patch.

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 :|