[libvirt]Support hw_vif_model = igb

Makes igb vif model supported for hosts with libvirt 9.3.0 and qemu
8.0.0 or higher.

Implements: blueprint igb-vif-model

Depends-On: https://review.opendev.org/c/openstack/os-traits/+/928582
(merged, released as 3.2.0)

Change-Id: I6a1d8058c640e5dc015889610c4ae864ed9a5ccb

Author: gibizer

nova/tests/functional/libvirt/test_vif_model.py

@@ -0,0 +1,97 @@
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import datetime
+
+from oslo_config import cfg
+from oslo_utils.fixture import uuidsentinel as uuids
+
+import nova
+from nova.tests.functional.libvirt import base
+
+CONF = cfg.CONF
+
+
+class LibvirtVifModelTest(base.ServersTestBase):
+    ADMIN_API = True
+
+    def setUp(self):
+        CONF.set_default("image_metadata_prefilter", True, group='scheduler')
+        super().setUp()
+
+        self.glance.create(
+            None,
+            {
+                'id': uuids.image_vif_model_igb,
+                'name': 'image-with-igb',
+                'created_at': datetime.datetime(2011, 1, 1, 1, 2, 3),
+                'updated_at': datetime.datetime(2011, 1, 1, 1, 2, 3),
+                'deleted_at': None,
+                'deleted': False,
+                'status': 'active',
+                'is_public': False,
+                'container_format': 'bare',
+                'disk_format': 'qcow2',
+                'size': '74185822',
+                'min_ram': 0,
+                'min_disk': 0,
+                'protected': False,
+                'visibility': 'public',
+                'tags': [],
+                'properties': {
+                    'hw_vif_model': 'igb',
+                },
+            }
+        )
+
+    def test_boot_with_vif_model_igb(self):
+        orig_create = nova.virt.libvirt.guest.Guest.create
+        self.xml = ""
+
+        def fake_create(cls, xml, host):
+            self.xml = xml
+            return orig_create(xml, host)
+
+        self.stub_out('nova.virt.libvirt.guest.Guest.create', fake_create)
+
+        self.start_compute(
+            hostname='compute1',
+            libvirt_version=9003000,
+            qemu_version=8000000,
+        )
+
+        self._create_server(image_uuid=uuids.image_vif_model_igb)
+        self.assertIn('<model type="igb"/>', self.xml)
+
+    def _test_boot_with_vif_model_igb_old_hypervisor(
+        self, libvirt_version, qemu_version
+    ):
+        self.start_compute(
+            hostname='compute1',
+            libvirt_version=libvirt_version,
+            qemu_version=qemu_version,
+        )
+
+        server = self._create_server(
+            image_uuid=uuids.image_vif_model_igb, expected_state='ERROR')
+        self.assertEqual(
+            "No valid host was found. ", server['fault']['message'])
+
+    def test_boot_with_vif_model_igb_old_qemu(self):
+        self._test_boot_with_vif_model_igb_old_hypervisor(
+            libvirt_version=9003000, qemu_version=7000000)
+
+    def test_boot_with_vif_model_igb_old_libvirt(self):
+        self._test_boot_with_vif_model_igb_old_hypervisor(
+            libvirt_version=9002000, qemu_version=8000000)

nova/tests/unit/virt/libvirt/test_driver.py

@@ -28186,7 +28186,9 @@ def test_storage_bus_traits__non_qemu_kvm(self):
                 bus_from_trait = trait.rsplit('_', 1)[1].lower()
                 self.assertEqual(bus_from_trait in buses, bus_traits[trait])
 
-    def test_vif_model_traits(self):
+    @mock.patch.object(
+        host.Host, 'has_min_version', return_value=True)
+    def test_vif_model_traits(self, mock_has_min_version):
         """Test getting vif model traits per virt type."""
         for virt_type, models in libvirt_vif.SUPPORTED_VIF_MODELS.items():
             self.flags(virt_type=virt_type, group='libvirt')
@@ -28200,6 +28202,24 @@ def test_vif_model_traits(self):
                 vif_models.pop(trait)
             self.assertTrue(all(not model for model in vif_models.values()))
 
+        mock_has_min_version.assert_called_with((9, 3, 0), (8, 0, 0))
+
+    @mock.patch.object(
+        host.Host, 'has_min_version', return_value=False)
+    def test_vif_model_traits_old_version_no_igb_support(
+        self, mock_has_min_version
+    ):
+        """Test getting vif model traits per virt type from old system not
+        supporting igb.
+        """
+        for virt_type in ('qemu', 'kvm'):
+            models = libvirt_vif.SUPPORTED_VIF_MODELS[virt_type]
+            self.assertIn(network_model.VIF_MODEL_IGB, models)
+            vif_models = self.drvr._get_vif_model_traits()
+            self.assertFalse(vif_models['COMPUTE_NET_VIF_MODEL_IGB'])
+
+        mock_has_min_version.assert_called_with((9, 3, 0), (8, 0, 0))
+
     def test_video_model_traits(self):
         """Test getting video model traits per virt type."""
         # NOTE(sean-k-mooney): we do not have a static tables of which video

nova/virt/libvirt/driver.py

@@ -260,6 +260,10 @@ def repr_method(self):
 # stateless firmware support
 MIN_LIBVIRT_STATELESS_FIRMWARE = (8, 6, 0)
 
+# Minimum versions supporting igb hw_vif_model
+MIN_IGB_LIBVIRT_VERSION = (9, 3, 0)
+MIN_IGB_QEMU_VERSION = (8, 0, 0)
+
 REGISTER_IMAGE_PROPERTY_DEFAULTS = [
     'hw_machine_type',
     'hw_cdrom_bus',
@@ -12990,6 +12994,15 @@ def _get_vif_model_traits(self) -> ty.Dict[str, bool]:
         supported_models = libvirt_vif.SUPPORTED_VIF_MODELS.get(
             CONF.libvirt.virt_type, []
         )
+
+        # remove version dependent vif models if we are on older libvirt/qemu
+        igb_supported = self._host.has_min_version(
+            MIN_IGB_LIBVIRT_VERSION, MIN_IGB_QEMU_VERSION)
+        if not igb_supported:
+            supported_models = [
+                model for model in supported_models
+                if model != network_model.VIF_MODEL_IGB]
+
         # construct the corresponding standard trait from the VIF model name
         return {
             f'COMPUTE_NET_VIF_MODEL_{model.replace("-", "_").upper()}': model

nova/virt/libvirt/vif.py

@@ -61,6 +61,7 @@
         network_model.VIF_MODEL_LAN9118,
         network_model.VIF_MODEL_SPAPR_VLAN,
         network_model.VIF_MODEL_VMXNET3,
+        network_model.VIF_MODEL_IGB,
     ],
     'kvm': [
         network_model.VIF_MODEL_VIRTIO,
@@ -71,6 +72,7 @@
         network_model.VIF_MODEL_E1000E,
         network_model.VIF_MODEL_SPAPR_VLAN,
         network_model.VIF_MODEL_VMXNET3,
+        network_model.VIF_MODEL_IGB,
     ],
     'lxc': [],
     'parallels': [

releasenotes/notes/bp-igb-vif-model-d1366bcbea7afdd2.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    The libvirt driver now supports hw_vif_model=igb image property
+    if the hypervisor has libvirt version 9.3.0 and qemu version 8.0.0
+    or higher.

requirements.txt

@@ -52,7 +52,7 @@ psutil>=3.2.2 # BSD
 oslo.versionedobjects>=1.35.0 # Apache-2.0
 os-brick>=6.0 # Apache-2.0
 os-resource-classes>=1.1.0 # Apache-2.0
-os-traits>=3.1.0 # Apache-2.0
+os-traits>=3.2.0 # Apache-2.0
 os-vif>=3.1.0 # Apache-2.0
 castellan>=0.16.0 # Apache-2.0
 microversion-parse>=0.2.1 # Apache-2.0