os-vif 3.1.0__tar.gz → 3.2.0__tar.gz

{os_vif-3.1.0 → os_vif-3.2.0}/.zuul.yaml

@@ -21,6 +21,7 @@
       - openstack/tempest
     vars:
       tempest_concurrency: 4
+      configure_swap_size: 8192
       tox_envlist: full
       devstack_plugins:
         neutron: https://opendev.org/openstack/neutron.git

{os_vif-3.1.0 → os_vif-3.2.0}/AUTHORS

@@ -1,6 +1,7 @@
 Adrian Chiris <adrianc@mellanox.com>
 Alin Balutoiu <abalutoiu@cloudbasesolutions.com>
 Andreas Jaeger <aj@suse.com>
+Balazs Gibizer <gibi@redhat.com>
 Brian Haley <brian.haley@hpe.com>
 Cao Xuan Hoang <hoangcx@vn.fujitsu.com>
 Carlos Goncalves <cgoncalves@redhat.com>
@@ -78,4 +79,5 @@ qingszhao <zhao.daqing@99cloud.net>
 shaleijie <sha.leijie@99cloud.net>
 sunjia <sunjia@inspur.com>
 vagrant <vagrant@devstack>
+wangjiaqi07 <wangjiaqi07@inspur.com>
 wu.shiming <wushiming@yovole.com>

{os_vif-3.1.0 → os_vif-3.2.0}/ChangeLog

@@ -1,6 +1,21 @@
 CHANGES
 =======
 
+3.2.0
+-----
+
+* remove focal based jobs
+* set default qos policy
+* Update master for stable/2023.1
+
+3.1.1
+-----
+
+* Increase the swap size to 8GB in tempest jobs
+* Implement "BaseCommand" result property
+* Update gate jobs as per the 2023.1 cycle testing runtime
+* Make tox.ini tox 4.0.0 compatible
+
 3.1.0
 -----
 
@@ -8,6 +23,7 @@ CHANGES
 * Move mtu update request into ovsdb transaction
 * Switch to 2023.1 Python3 unit tests and generic template name
 * Update master for stable/zed
+* remove unicode from code
 
 3.0.0
 -----

{os_vif-3.1.0 → os_vif-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: os_vif
-Version: 3.1.0
+Version: 3.2.0
 Summary: A library for plugging and unplugging virtual interfaces in OpenStack.
 Home-page: https://docs.openstack.org/os-vif/latest/
 Author: OpenStack

{os_vif-3.1.0 → os_vif-3.2.0}/doc/source/conf.py

@@ -34,7 +34,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-copyright = u'2016, OpenStack Foundation'
+copyright = '2016, OpenStack Foundation'
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True

{os_vif-3.1.0 → os_vif-3.2.0}/os_vif/tests/functional/internal/command/ip/test_impl_pyroute2.py

@@ -12,6 +12,7 @@
 
 import os
 import re
+import time
 
 from oslo_concurrency import processutils
 from oslo_utils import excutils
@@ -39,6 +40,12 @@ class ShellIpCommands(object):
                              'peer', 'name', peer)
         elif 'dummy' == dev_type:
             _execute_command('ip', 'link', 'add', device, 'type', dev_type)
+        # ensure that the device exists to prevent racing
+        # with other ip commands
+        for _ in range(10):
+            if self.exist_device(device):
+                return
+            time.sleep(0.1)
 
     def del_device(self, device):
         if self.exist_device(device):

{os_vif-3.1.0 → os_vif-3.2.0}/os_vif/tests/functional/privsep.py

@@ -17,5 +17,5 @@ os_vif_pctxt = priv_context.PrivContext(
     'os_vif',
     cfg_section='os_vif_privileged',
     pypath=__name__ + '.os_vif_pctxt',
-    capabilities=[c.CAP_NET_ADMIN],
+    capabilities=[c.CAP_NET_ADMIN, c.CAP_DAC_OVERRIDE],
 )

{os_vif-3.1.0 → os_vif-3.2.0}/os_vif.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: os-vif
-Version: 3.1.0
+Version: 3.2.0
 Summary: A library for plugging and unplugging virtual interfaces in OpenStack.
 Home-page: https://docs.openstack.org/os-vif/latest/
 Author: OpenStack

{os_vif-3.1.0 → os_vif-3.2.0}/os_vif.egg-info/SOURCES.txt

@@ -97,6 +97,7 @@ releasenotes/notes/always-plug-vifs-for-ovs-1d033fc49a9c6c4e.yaml
 releasenotes/notes/brctl-removal-a5b0e69b865afa57.yaml
 releasenotes/notes/bug-1892132-812e6d5ce0588ebb.yaml
 releasenotes/notes/contextlib-and-nested-with-statements-2747a9ebb9a5bfd7.yaml
+releasenotes/notes/default-qos-policy-for-ovs-26f8806046a59c82.yaml
 releasenotes/notes/default-to-native-ovsdb-driver-112fb5adf6e19a30.yaml
 releasenotes/notes/do-not-force-mac-ageing-c6e8d750130c5740.yaml
 releasenotes/notes/drop-py36-support-0e9b07073f6ad73f.yaml
@@ -117,6 +118,7 @@ releasenotes/notes/remove_iptools_implementation-2eb866573a680e61.yaml
 releasenotes/notes/revert-always-plug-port-for-ovs-hybrid-plug-false-dc015985cbc5443b.yaml
 releasenotes/notes/vhost-user-mtu-support-cbc7d02a6665fab1.yaml
 releasenotes/notes/vhost-user-reconnect-fa4cbb731b787f71.yaml
+releasenotes/source/2023.1.rst
 releasenotes/source/conf.py
 releasenotes/source/index.rst
 releasenotes/source/newton.rst

os_vif-3.2.0/os_vif.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "da742a8", "is_release": true}

os_vif-3.2.0/releasenotes/notes/default-qos-policy-for-ovs-26f8806046a59c82.yaml

@@ -0,0 +1,33 @@
+---
+upgrade:
+  - |
+    A new config option has been added to the OpenvSwitch plugin
+    ``[os_vif_ovs]default_qos_type``. This option controls
+    the Default tc qdisc applied to a kernel interface attached to OpenvSwitch
+    on Linux hosts. As of this release, the default tc qdisc is ``linux-noop``
+    other supported values are ``linux-htb``, ``linux-hfsc``,
+    ``linux-sfq``, ``linux-codel`` and  ``linux-fq_codel``.
+    before this release the default qdisc was undefined. older kernels did not
+    apply  /proc/sys/net/core/default_qdisc to tap devices. newer kernels such
+    as the one found in rhel 9 do. This can significantly impact performance.
+    See bug https://bugs.launchpad.net/os-vif/+bug/2017868 for more details.
+    The default ``linux-noop`` should perform well for all use-cases so no
+    explicit action is required on upgrade however it should be noted that
+    the default_qos_type is only set when a port is first created. As such
+    this fix will not take effect until the next time the vm interface is
+    recreated. If you change this value for an existing port it will only
+    take effect after a hard reboot of the VM or a move operation.
+
+fixes:
+  - |
+    A significant performance regression was observed on a subset of Linux
+    kernels and sysctl configurations resulting in a reduction of throughput
+    to between 10% of the prior performance for small packets and 50% for
+    large packets. This has now been resolved by setting a default
+    qos_type on ovs interfaces when they are first created. To mimic libvirt's
+    undocumented behavior the ``linux-noop`` type is set on the ovs port when
+    it is first created. This will be overridden by neutron if a qos policy
+    is defined for a port and is simply the initial value to use when first
+    adding a port to OpenvSwitch. The default QoS type applied can be
+    controlled by the ``[os_vif_ovs]default_qos_type`` config operation.
+    See bug https://bugs.launchpad.net/os-vif/+bug/2017868 for more details.

os_vif-3.2.0/releasenotes/source/2023.1.rst

@@ -0,0 +1,6 @@
+===========================
+2023.1 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2023.1

{os_vif-3.1.0 → os_vif-3.2.0}/releasenotes/source/conf.py

@@ -30,7 +30,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-copyright = u'2017, OpenStack Foundation'
+copyright = '2017, OpenStack Foundation'
 
 # Release notes do not need a version in the title, they span
 # multiple versions.

{os_vif-3.1.0 → os_vif-3.2.0}/releasenotes/source/index.rst

@@ -6,6 +6,7 @@ Release Notes
    :maxdepth: 1
 
    unreleased
+   2023.1
    zed
    yoga
    xena

{os_vif-3.1.0 → os_vif-3.2.0}/tox.ini

@@ -1,11 +1,8 @@
 [tox]
 minversion = 3.18.0
 envlist = py3,pep8,docs,releasenotes,cover
-skipsdist = True
-ignore_basepython_conflict = True
 
 [testenv]
-basepython = python3
 usedevelop = True
 setenv =
 deps =
@@ -88,5 +85,7 @@ import_exceptions = os_vif.i18n
 # system dependencies are missing, since it's used to tell you what system
 # dependencies are missing! This also means that bindep must be installed
 # separately, outside of the requirements files.
+skipsdist=True
+usedevelop=False
 deps = bindep
 commands = bindep test

{os_vif-3.1.0 → os_vif-3.2.0}/vif_plug_ovs/ovs.py

@@ -102,7 +102,26 @@ class OvsPlugin(plugin.PluginBase):
                     'bridge. This is experimental and controls the plugging '
                     'behavior when not using hybrid-plug.'
                     'This is only used on linux and should be set to false '
-                    'in all other cases such as ironic smartnic ports.')
+                    'in all other cases such as ironic smartnic ports.'),
+        cfg.StrOpt('default_qos_type',
+                   choices=[
+                       'linux-htb', 'linux-hfsc', 'linux-sfq', 'linux-codel',
+                       'linux-fq_codel', 'linux-noop'
+                       ],
+                   default='linux-noop',
+                   help="""
+                   The default qos type to apply to ovs ports.
+                   linux-noop is the default. ovs will not modify
+                   the qdisc on the port if linux-noop is specified.
+                   This allows operators to manage QOS out of band
+                   of OVS. For more information see the ovs man pages
+                   https://manpages.debian.org/testing/openvswitch-common/ovs-vswitchd.conf.db.5.en.html#type~4
+
+                   Note: This will only be set when a port is first created
+                   on the ovs bridge to ensure that the qos type can be
+                   managed via neutron if required for bandwidth limiting
+                   and other use-cases.
+                   """),
     )
 
     def __init__(self, config):
@@ -159,6 +178,14 @@ class OvsPlugin(plugin.PluginBase):
             return vif.network.mtu
         return self.config.network_device_mtu
 
+    def supports_tc_qdisc(self, vif) -> bool:
+        if self._get_vif_datapath_type(vif) != constants.OVS_DATAPATH_SYSTEM:
+            return False
+        if sys.platform == constants.PLATFORM_WIN32:
+            return False
+
+        return True
+
     def _create_vif_port(self, vif, vif_name, instance_info, **kwargs):
         mtu = self._get_mtu(vif)
         # NOTE(sean-k-mooney): As part of a partial fix to bug #1734320
@@ -175,6 +202,19 @@ class OvsPlugin(plugin.PluginBase):
         # can be enabled automatically in the future.
         if self.config.isolate_vif:
             kwargs['tag'] = constants.DEAD_VLAN
+        qos_type = self._get_qos_type(vif)
+        if qos_type is not None:
+            # NOTE(sean-k-mooney): If the port is not already created
+            # on the bridge we need to set the default qos type to
+            # ensure that the port is created with the correct qos
+            # type. This is only needed for the linux kernel datapath
+            # as the qos type is not managed by neutron for the other
+            # datapaths.
+            # This is a mitigation for the performance regression
+            # introduced by the fix for bug #1734320. See bug #2017868
+            # for more details.
+            if not self.ovsdb.port_exists(vif_name, vif.network.bridge):
+                kwargs['qos_type'] = qos_type
         bridge = kwargs.pop('bridge', vif.network.bridge)
         self.ovsdb.create_ovs_vif_port(
             bridge,
@@ -382,9 +422,18 @@ class OvsPlugin(plugin.PluginBase):
 
         linux_net.delete_bridge(linux_bridge_name, v1_name)
 
-        self.ovsdb.delete_ovs_vif_port(vif.network.bridge, v2_name)
+        qos_type = self._get_qos_type(vif)
+        self.ovsdb.delete_ovs_vif_port(
+            vif.network.bridge, v2_name, qos_type=qos_type
+        )
         self._delete_bridge_if_trunk(vif)
 
+    def _get_qos_type(self, vif):
+        qos_type = None
+        if self.supports_tc_qdisc(vif):
+            qos_type = self.config.default_qos_type
+        return qos_type
+
     def _unplug_vif_windows(self, vif, instance_info):
         """Remove port from OVS."""
         self.ovsdb.delete_ovs_vif_port(vif.network.bridge, vif.id,
@@ -400,7 +449,10 @@ class OvsPlugin(plugin.PluginBase):
         int_bridge_patch = self.gen_port_name('ibp', vif.id, max_length=64)
         self.ovsdb.delete_ovs_vif_port(vif.network.bridge, int_bridge_patch)
         self.ovsdb.delete_ovs_vif_port(port_bridge_name, port_bridge_patch)
-        self.ovsdb.delete_ovs_vif_port(port_bridge_name, vif.vif_name)
+        qos_type = self._get_qos_type(vif)
+        self.ovsdb.delete_ovs_vif_port(
+            port_bridge_name, vif.vif_name, qos_type=qos_type
+        )
         self.ovsdb.delete_ovs_bridge(port_bridge_name)
         self._delete_bridge_if_trunk(vif)
 
@@ -409,7 +461,10 @@ class OvsPlugin(plugin.PluginBase):
         # NOTE(sean-k-mooney): even with the partial revert of change
         # Iaf15fa7a678ec2624f7c12f634269c465fbad930 this should be correct
         # so this is not removed.
-        self.ovsdb.delete_ovs_vif_port(vif.network.bridge, vif.vif_name)
+        qos_type = self._get_qos_type(vif)
+        self.ovsdb.delete_ovs_vif_port(
+            vif.network.bridge, vif.vif_name, qos_type=qos_type
+        )
         self._delete_bridge_if_trunk(vif)
 
     def _unplug_vf(self, vif):
@@ -428,8 +483,11 @@ class OvsPlugin(plugin.PluginBase):
         # The representor interface can't be deleted because it bind the
         # SR-IOV VF, therefore we just need to remove it from the ovs bridge
         # and set the status to down
+        qos_type = self._get_qos_type(vif)
         self.ovsdb.delete_ovs_vif_port(
-            vif.network.bridge, representor, delete_netdev=False)
+            vif.network.bridge, representor, delete_netdev=False,
+            qos_type=qos_type
+        )
         if datapath == constants.OVS_DATAPATH_SYSTEM:
             linux_net.set_interface_state(representor, 'down')
         self._delete_bridge_if_trunk(vif)

{os_vif-3.1.0 → os_vif-3.2.0}/vif_plug_ovs/ovsdb/impl_idl.py

@@ -23,7 +23,7 @@ from ovsdbapp.schema.open_vswitch import impl_idl
 
 from vif_plug_ovs.ovsdb import api
 
-REQUIRED_TABLES = ('Interface', 'Port', 'Bridge', 'Open_vSwitch')
+REQUIRED_TABLES = ('Interface', 'Port', 'Bridge', 'Open_vSwitch', 'QoS')
 
 
 def idl_factory(config):
@@ -48,6 +48,7 @@ class NeutronOvsdbIdl(impl_idl.OvsdbIdl, api.ImplAPI):
     This class provides an OVSDB IDL (Open vSwitch Database Interface
     Definition Language) interface to the OVS back-end.
     """
+
     def __init__(self, conn):
         vlog.use_python_logger()
         super(NeutronOvsdbIdl, self).__init__(conn)

{os_vif-3.1.0 → os_vif-3.2.0}/vif_plug_ovs/ovsdb/impl_vsctl.py

@@ -116,6 +116,15 @@ class BaseCommand(ovsdb_api.Command):
         self.cmd = cmd
         self.opts = [] if opts is None else opts
         self.args = [] if args is None else args
+        self._result = None
+
+    @property
+    def result(self):
+        return self._result
+
+    @result.setter
+    def result(self, value):
+        self._result = value
 
     def execute(self, check_error=False, log_errors=True):
         with Transaction(self.context, check_error=check_error,

{os_vif-3.1.0 → os_vif-3.2.0}/vif_plug_ovs/ovsdb/ovsdb_lib.py

@@ -11,6 +11,7 @@
 #    under the License.
 
 import sys
+import uuid
 
 from oslo_log import log as logging
 
@@ -20,6 +21,7 @@ from vif_plug_ovs.ovsdb import api as ovsdb_api
 
 
 LOG = logging.getLogger(__name__)
+QOS_UUID_NAMESPACE = uuid.UUID("68da264a-847f-42a8-8ab0-5e774aee3d95")
 
 
 class BaseOVS(object):
@@ -142,7 +144,8 @@ class BaseOVS(object):
     def create_ovs_vif_port(
         self, bridge, dev, iface_id, mac, instance_id,
         mtu=None, interface_type=None, vhost_server_path=None,
-        tag=None, pf_pci=None, vf_num=None, set_ids=True, datapath_type=None
+        tag=None, pf_pci=None, vf_num=None, set_ids=True, datapath_type=None,
+        qos_type=None
     ):
         """Create OVS port
 
@@ -159,6 +162,7 @@ class BaseOVS(object):
         :param vf_num: VF number of PF for dpdk representor port.
         :param set_ids: set external ids on port (bool).
         :param datapath_type: datapath type for port's bridge
+        :param qos_type: qos type for a port
 
         .. note:: create DPDK representor port by setting all three values:
             `interface_type`, `pf_pci` and `vf_num`. if interface type is
@@ -181,6 +185,24 @@ class BaseOVS(object):
                 PF_PCI=pf_pci, VF_NUM=vf_num)
             col_values.append(('options',
                               {'dpdk-devargs': devargs_string}))
+        # create qos record if qos type is specified
+        # and get the qos id. This is done outside of the transaction
+        # because we need the qos id to set the qos on the port.
+        # The qos uuid cannot be set when creating the record so we
+        # have to look it up after the record is created. this means
+        # we need to create the qos record outside of the transaction
+        # that creates the port.
+        qid = None
+        if qos_type:
+            self.delete_qos_if_exists(dev, qos_type)
+            qos_id = uuid.uuid5(QOS_UUID_NAMESPACE, dev)
+            qos_external_ids = {'id': str(qos_id), '_type': qos_type}
+            self.ovsdb.db_create(
+                'QoS', type=qos_type, external_ids=qos_external_ids
+                ).execute(check_error=True)
+            record = self.get_qos(dev, qos_type)
+            qid = record[0]['_uuid']
+
         with self.ovsdb.transaction() as txn:
             if datapath_type:
                 txn.add(self.ovsdb.add_br(bridge, may_exist=True,
@@ -188,19 +210,46 @@ class BaseOVS(object):
             txn.add(self.ovsdb.add_port(bridge, dev))
             if tag:
                 txn.add(self.ovsdb.db_set('Port', dev, ('tag', tag)))
+            if qid:
+                txn.add(self.ovsdb.db_set('Port', dev, ('qos', qid)))
             if col_values:
                 txn.add(self.ovsdb.db_set('Interface', dev, *col_values))
             self.update_device_mtu(
                 txn, dev, mtu, interface_type=interface_type
             )
 
+    def port_exists(self, port_name, bridge):
+        ports = self.ovsdb.list_ports(bridge).execute()
+        return ports is not None and port_name in ports
+
+    def get_qos(self, dev, qos_type):
+        qos_id = uuid.uuid5(QOS_UUID_NAMESPACE, dev)
+        external_ids = {'id': str(qos_id), '_type': qos_type}
+        return self.ovsdb.db_find(
+            'QoS', ('external_ids', '=', external_ids),
+            colmuns=['_uuid']
+        ).execute()
+
+    def delete_qos_if_exists(self, dev, qos_type):
+        qos_ids = self.get_qos(dev, qos_type)
+        if qos_ids is not None and len(qos_ids) > 0:
+            for qos_id in qos_ids:
+                if '_uuid' in qos_id:
+                    self.ovsdb.db_destroy(
+                        'QoS', str(qos_id['_uuid'])
+                    ).execute()
+
     def update_ovs_vif_port(self, dev, mtu=None, interface_type=None):
         with self.ovsdb.transaction() as txn:
             self.update_device_mtu(
                 txn, dev, mtu, interface_type=interface_type
             )
 
-    def delete_ovs_vif_port(self, bridge, dev, delete_netdev=True):
+    def delete_ovs_vif_port(
+            self, bridge, dev, delete_netdev=True, qos_type=None
+    ):
         self.ovsdb.del_port(dev, bridge=bridge, if_exists=True).execute()
+        if qos_type:
+            self.delete_qos_if_exists(dev, qos_type)
         if delete_netdev:
             linux_net.delete_net_dev(dev)

{os_vif-3.1.0 → os_vif-3.2.0}/vif_plug_ovs/privsep.py

@@ -20,5 +20,16 @@ vif_plug = priv_context.PrivContext(
     "vif_plug_ovs",
     cfg_section="vif_plug_ovs_privileged",
     pypath=__name__ + ".vif_plug",
-    capabilities=[c.CAP_NET_ADMIN],
+    capabilities=[
+        c.CAP_NET_ADMIN,
+    ],
+)
+
+vif_plug_test = priv_context.PrivContext(
+    "vif_plug_ovs",
+    cfg_section="vif_plug_ovs_privileged",
+    pypath=__name__ + ".vif_plug_test",
+    capabilities=[
+        c.CAP_NET_ADMIN, c.CAP_DAC_OVERRIDE,
+    ],
 )

{os_vif-3.1.0 → os_vif-3.2.0}/vif_plug_ovs/tests/functional/base.py

@@ -25,6 +25,22 @@ class VifPlugOvsBaseFunctionalTestCase(os_vif_base.BaseFunctionalTestCase):
     def _check_bridge(self, name):
         return self._ovsdb.br_exists(name).execute()
 
+    def _check_port(self, name, bridge):
+        return self.ovs.port_exists(name, bridge)
+
+    def _check_parameter(self, table, port, parameter, expected_value):
+        def get_value():
+            return self._ovsdb.db_get(table, port, parameter).execute()
+
+        def check_value():
+            val = get_value()
+            return val == expected_value
+        self.assertTrue(
+            wait_until_true(check_value, timeout=2, sleep=0.5),
+            f"Parameter {parameter} of {table} {port} is {get_value()} "
+            f"not {expected_value}"
+        )
+
     def _add_bridge(self, name, may_exist=True, datapath_type=None):
         self._ovsdb.add_br(name, may_exist=may_exist,
                            datapath_type=datapath_type).execute()