trex: fix Trex makefile

[vswitchperf.git] / vswitches / ovs.py

diff --git a/vswitches/ovs.py b/vswitches/ovs.py
index dd49a1f..12620e2 100644 (file)
--- a/vswitches/ovs.py
+++ b/vswitches/ovs.py
@@ -1,4 +1,4 @@
-# Copyright 2015-2016 Intel Corporation.
+# Copyright 2015-2017 Intel Corporation.

 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.


@@ -16,41 +16,98 @@
 """
 
 import logging
 """
 
 import logging

+import os

 import re
 import re

+import time
+import datetime
+import random
+import pexpect
+

 from conf import settings
 from conf import settings

-from vswitches.vswitch import IVSwitch

 from src.ovs import OFBridge, flow_key, flow_match
 from src.ovs import OFBridge, flow_key, flow_match

-
-_VSWITCHD_CONST_ARGS = []
-
-class IVSwitchOvs(IVSwitch):
+from vswitches.vswitch import IVSwitch
+from tools import tasks
+from tools.module_manager import ModuleManager
+# pylint: disable=too-many-public-methods
+class IVSwitchOvs(IVSwitch, tasks.Process):

     """Open vSwitch base class implementation
 
     The method docstrings document only considerations specific to this
     implementation. For generic information of the nature of the methods,
     see the interface.
     """
     """Open vSwitch base class implementation
 
     The method docstrings document only considerations specific to this
     implementation. For generic information of the nature of the methods,
     see the interface.
     """

+    _proc_name = 'ovs-vswitchd'

 
     def __init__(self):
         """See IVswitch for general description
         """
 
     def __init__(self):
         """See IVswitch for general description
         """

-        self._vswitchd = None
+        self._logfile = os.path.join(settings.getValue('LOG_DIR'),
+                                     settings.getValue('LOG_FILE_VSWITCHD'))
+        self._ovsdb_pidfile_path = os.path.join(settings.getValue('TOOLS')['ovs_var_tmp'],
+                                                "ovsdb-server.pid")
+        self._vswitchd_pidfile_path = os.path.join(settings.getValue('TOOLS')['ovs_var_tmp'],
+                                                   "{}.pid".format(self._proc_name))

         self._logger = logging.getLogger(__name__)
         self._logger = logging.getLogger(__name__)

+        self._expect = r'bridge|INFO|{}'.format(self._proc_name)
+        self._timeout = 30

         self._bridges = {}
         self._bridges = {}

-        self._vswitchd_args = _VSWITCHD_CONST_ARGS
+        self._vswitchd_args = ['--pidfile=' + self._vswitchd_pidfile_path,
+                               '--overwrite-pidfile', '--log-file=' + self._logfile]
+        self._cmd = []
+        self._cmd_template = ['sudo', '-E', settings.getValue('TOOLS')['ovs-vswitchd']]
+        self._stamp = None
+        self._module_manager = ModuleManager()

 
     def start(self):
 
     def start(self):

-        """See IVswitch for general description
+        """ Start ``ovsdb-server`` and ``ovs-vswitchd`` instance.
+
+        :raises: pexpect.EOF, pexpect.TIMEOUT

         """
         self._logger.info("Starting vswitchd...")
         """
         self._logger.info("Starting vswitchd...")

-        self._vswitchd.start()
+
+        # insert kernel modules if required
+        if 'vswitch_modules' in settings.getValue('TOOLS'):
+            self._module_manager.insert_modules(settings.getValue('TOOLS')['vswitch_modules'])
+
+        self._cmd = self._cmd_template + self._vswitchd_args
+
+        # DB must be started before vswitchd
+        self._reset_ovsdb()
+        self._start_ovsdb()
+
+        # DB must be up before vswitchd config is altered or vswitchd started
+        time.sleep(3)
+
+        self.configure()
+
+        try:
+            tasks.Process.start(self)
+            self.relinquish()
+        except (pexpect.EOF, pexpect.TIMEOUT) as exc:
+            logging.error("Exception during VSwitch start.")
+            self._kill_ovsdb()
+            raise exc
+

         self._logger.info("Vswitchd...Started.")
 
         self._logger.info("Vswitchd...Started.")
 

+    def configure(self):
+        """ Configure vswitchd through ovsdb if needed
+        """
+        pass
+
+    # Method could be a function
+    # pylint: disable=no-self-use
+    def get_version(self):
+        """See IVswitch for general description
+        """
+        # OVS version can be read offline
+        return []
+

     def stop(self):
         """See IVswitch for general description
         """
         self._logger.info("Terminating vswitchd...")
     def stop(self):
         """See IVswitch for general description
         """
         self._logger.info("Terminating vswitchd...")

-        self._vswitchd.kill()
+        self.kill()

         self._logger.info("Vswitchd...Terminated.")
 
     def add_switch(self, switch_name, params=None):
         self._logger.info("Vswitchd...Terminated.")
 
     def add_switch(self, switch_name, params=None):


@@ -80,6 +137,38 @@ class IVSwitchOvs(IVSwitch):
         """
         raise NotImplementedError
 
         """
         raise NotImplementedError
 

+    def add_veth_pair_port(self, switch_name=None, remote_switch_name=None,
+                           local_opts=None, remote_opts=None):
+        """Creates veth-pair port between 'switch_name' and 'remote_switch_name'
+
+        """
+        if switch_name is None or remote_switch_name is None:
+            return
+
+        bridge = self._bridges[switch_name]
+        remote_bridge = self._bridges[remote_switch_name]
+        pcount = str(self._get_port_count('type=patch'))
+        # NOTE ::: What if interface name longer than allowed width??
+        local_port_name = switch_name + '-' + remote_switch_name + '-' + pcount
+        remote_port_name = remote_switch_name + '-' + switch_name + '-' + pcount
+        local_params = ['--', 'set', 'Interface', local_port_name,
+                        'type=patch',
+                        'options:peer=' + remote_port_name]
+        remote_params = ['--', 'set', 'Interface', remote_port_name,
+                         'type=patch',
+                         'options:peer=' + local_port_name]
+
+        if local_opts is not None:
+            local_params = local_params + local_opts
+
+        if remote_opts is not None:
+            remote_params = remote_params + remote_opts
+
+        local_of_port = bridge.add_port(local_port_name, local_params)
+        remote_of_port = remote_bridge.add_port(remote_port_name, remote_params)
+        return [(local_port_name, local_of_port),
+                (remote_port_name, remote_of_port)]
+

     def add_tunnel_port(self, switch_name, remote_ip, tunnel_type='vxlan', params=None):
         """Creates tunneling port
         """
     def add_tunnel_port(self, switch_name, remote_ip, tunnel_type='vxlan', params=None):
         """Creates tunneling port
         """


@@ -153,7 +242,151 @@ class IVSwitchOvs(IVSwitch):
             cnt = 0
         return cnt
 
             cnt = 0
         return cnt
 

-    def validate_add_switch(self, result, switch_name, params=None):
+    def disable_stp(self, switch_name):
+        """
+        Disable stp protocol on the bridge
+        :param switch_name: bridge to disable stp
+        :return: None
+        """
+        bridge = self._bridges[switch_name]
+        bridge.set_stp(False)
+        self._logger.info('Sleeping for 50 secs to allow stp to stop.')
+        time.sleep(50)  # needs time to disable
+
+    def enable_stp(self, switch_name):
+        """
+        Enable stp protocol on the bridge
+        :param switch_name: bridge to enable stp
+        :return: None
+        """
+        bridge = self._bridges[switch_name]
+        bridge.set_stp(True)
+        self._logger.info('Sleeping for 50 secs to allow stp to start.')
+        time.sleep(50)  # needs time to enable
+
+    def disable_rstp(self, switch_name):
+        """
+        Disable rstp on the bridge
+        :param switch_name: bridge to disable rstp
+        :return: None
+        """
+        bridge = self._bridges[switch_name]
+        bridge.set_rstp(False)
+        self._logger.info('Sleeping for 15 secs to allow rstp to stop.')
+        time.sleep(15)  # needs time to disable
+
+    def enable_rstp(self, switch_name):
+        """
+        Enable rstp on the bridge
+        :param switch_name: bridge to enable rstp
+        :return: None
+        """
+        bridge = self._bridges[switch_name]
+        bridge.set_rstp(True)
+        self._logger.info('Sleeping for 15 secs to allow rstp to start.')
+        time.sleep(15)  # needs time to enable
+
+    def kill(self, signal='-15', sleep=10):
+        """Kill ``ovs-vswitchd`` and ``ovs-ovsdb`` instances if they are alive.
+
+        :returns: None
+        """
+        if os.path.isfile(self._vswitchd_pidfile_path):
+            self._logger.info('Killing ovs-vswitchd...')
+            with open(self._vswitchd_pidfile_path, "r") as pidfile:
+                vswitchd_pid = pidfile.read().strip()
+                tasks.terminate_task(vswitchd_pid, logger=self._logger)
+
+        self._kill_ovsdb()  # ovsdb must be killed after vswitchd
+
+        # just for case, that sudo envelope has not been terminated yet
+        tasks.Process.kill(self, signal, sleep)
+
+    # helper functions
+
+    def _reset_ovsdb(self):
+        """Reset system for 'ovsdb'.
+
+        :returns: None
+        """
+        self._logger.info('Resetting system after last run...')
+
+        # create a backup of ovs_var_tmp and ovs_etc_tmp; It is
+        # essential for OVS installed from binary packages.
+        self._stamp = '{:%Y%m%d_%H%M%S}_{}'.format(datetime.datetime.now(),
+                                                   random.randrange(1000, 9999))
+        for tmp_dir in ['ovs_var_tmp', 'ovs_etc_tmp']:
+            if os.path.exists(settings.getValue('TOOLS')[tmp_dir]):
+                orig_dir = os.path.normpath(settings.getValue('TOOLS')[tmp_dir])
+                self._logger.info('Creating backup of %s directory...', tmp_dir)
+                tasks.run_task(['sudo', 'mv', orig_dir, '{}.{}'.format(orig_dir, self._stamp)],
+                               self._logger)
+
+        # create fresh tmp dirs
+        tasks.run_task(['sudo', 'mkdir', '-p', settings.getValue('TOOLS')['ovs_var_tmp']], self._logger)
+        tasks.run_task(['sudo', 'mkdir', '-p', settings.getValue('TOOLS')['ovs_etc_tmp']], self._logger)
+
+        self._logger.info('System reset after last run.')
+
+    def _start_ovsdb(self):
+        """Start ``ovsdb-server`` instance.
+
+        :returns: None
+        """
+        ovsdb_tool_bin = settings.getValue('TOOLS')['ovsdb-tool']
+        tasks.run_task(['sudo', ovsdb_tool_bin, 'create',
+                        os.path.join(settings.getValue('TOOLS')['ovs_etc_tmp'], 'conf.db'),
+                        settings.getValue('TOOLS')['ovsschema']],
+                       self._logger,
+                       'Creating ovsdb configuration database...')
+
+        ovsdb_server_bin = settings.getValue('TOOLS')['ovsdb-server']
+
+        tasks.run_background_task(
+            ['sudo', ovsdb_server_bin,
+             '--remote=punix:%s' % os.path.join(settings.getValue('TOOLS')['ovs_var_tmp'], 'db.sock'),
+             '--remote=db:Open_vSwitch,Open_vSwitch,manager_options',
+             '--pidfile=' + self._ovsdb_pidfile_path, '--overwrite-pidfile'],
+            self._logger,
+            'Starting ovsdb-server...')
+
+    def _kill_ovsdb(self):
+        """Kill ``ovsdb-server`` instance.
+
+        :returns: None
+        """
+        if os.path.isfile(self._ovsdb_pidfile_path):
+            with open(self._ovsdb_pidfile_path, "r") as pidfile:
+                ovsdb_pid = pidfile.read().strip()
+
+            self._logger.info("Killing ovsdb with pid: " + ovsdb_pid)
+
+            if ovsdb_pid:
+                tasks.terminate_task(ovsdb_pid, logger=self._logger)
+
+        # restore original content of ovs_var_tmp and ovs_etc_tmp; It is
+        # essential for OVS installed from binary packages.
+        if self._stamp:
+            for tmp_dir in ['ovs_var_tmp', 'ovs_etc_tmp']:
+                orig_dir = os.path.normpath(settings.getValue('TOOLS')[tmp_dir])
+                if os.path.exists('{}.{}'.format(orig_dir, self._stamp)):
+                    self._logger.info('Restoring backup of %s directory...', tmp_dir)
+                    tasks.run_task(['sudo', 'rm', '-rf', orig_dir], self._logger)
+                    tasks.run_task(['sudo', 'mv', '{}.{}'.format(orig_dir, self._stamp), orig_dir],
+                                   self._logger)
+
+    @staticmethod
+    def get_db_sock_path():
+        """Method returns location of db.sock file
+
+        :returns: path to db.sock file.
+        """
+        return os.path.join(settings.getValue('TOOLS')['ovs_var_tmp'], 'db.sock')
+
+    #
+    # validate methods required for integration testcases
+    #
+    def validate_add_switch(self, dummy_result, switch_name, dummy_params=None):

         """Validate - Create a new logical switch with no ports
         """
         bridge = self._bridges[switch_name]
         """Validate - Create a new logical switch with no ports
         """
         bridge = self._bridges[switch_name]


@@ -162,7 +395,9 @@ class IVSwitchOvs(IVSwitch):
         assert re.search('Bridge ["\']?%s["\']?' % switch_name, output[0]) is not None
         return True
 
         assert re.search('Bridge ["\']?%s["\']?' % switch_name, output[0]) is not None
         return True
 

-    def validate_del_switch(self, result, switch_name):
+    # Method could be a function
+    # pylint: disable=no-self-use
+    def validate_del_switch(self, dummy_result, switch_name):

         """Validate removal of switch
         """
         bridge = OFBridge('tmp')
         """Validate removal of switch
         """
         bridge = OFBridge('tmp')


@@ -186,7 +421,7 @@ class IVSwitchOvs(IVSwitch):
         """
         return self.validate_add_phy_port(result, switch_name)
 
         """
         return self.validate_add_phy_port(result, switch_name)
 

-    def validate_del_port(self, result, switch_name, port_name):
+    def validate_del_port(self, dummy_result, switch_name, port_name):

         """ Validate that port_name was removed from bridge.
         """
         bridge = self._bridges[switch_name]
         """ Validate that port_name was removed from bridge.
         """
         bridge = self._bridges[switch_name]


@@ -195,11 +430,12 @@ class IVSwitchOvs(IVSwitch):
         assert 'Port "%s"' % port_name not in output[0]
         return True
 
         assert 'Port "%s"' % port_name not in output[0]
         return True
 

-    def validate_add_flow(self, result, switch_name, flow, cache='off'):
+    def validate_add_flow(self, dummy_result, switch_name, flow, dummy_cache='off'):

         """ Validate insertion of the flow into the switch
         """
         """ Validate insertion of the flow into the switch
         """

+

         if 'idle_timeout' in flow:
         if 'idle_timeout' in flow:

-            del(flow['idle_timeout'])
+            del flow['idle_timeout']

 
         # Note: it should be possible to call `ovs-ofctl dump-flows switch flow`
         # to verify flow insertion, but it doesn't accept the same flow syntax
 
         # Note: it should be possible to call `ovs-ofctl dump-flows switch flow`
         # to verify flow insertion, but it doesn't accept the same flow syntax


@@ -215,15 +451,39 @@ class IVSwitchOvs(IVSwitch):
                 return True
         return False
 
                 return True
         return False
 

-    def validate_del_flow(self, result, switch_name, flow=None):
+    def validate_del_flow(self, dummy_result, switch_name, flow=None):

         """ Validate removal of the flow
         """
         if not flow:
             # what else we can do?
             return True
         """ Validate removal of the flow
         """
         if not flow:
             # what else we can do?
             return True

-        return not self.validate_add_flow(result, switch_name, flow)
+        return not self.validate_add_flow(dummy_result, switch_name, flow)

 
 

-    def validate_dump_flows(self, result, switch_name):
+    def validate_dump_flows(self, dummy_result, dummy_switch_name):

         """ Validate call of flow dump
         """
         return True
         """ Validate call of flow dump
         """
         return True

+
+    def validate_disable_rstp(self, dummy_result, switch_name):
+        """ Validate rstp disable
+        """
+        bridge = self._bridges[switch_name]
+        return 'rstp_enable         : false' in ''.join(bridge.bridge_info())
+
+    def validate_enable_rstp(self, dummy_result, switch_name):
+        """ Validate rstp enable
+        """
+        bridge = self._bridges[switch_name]
+        return 'rstp_enable         : true' in ''.join(bridge.bridge_info())
+
+    def validate_disable_stp(self, dummy_result, switch_name):
+        """ Validate stp disable
+        """
+        bridge = self._bridges[switch_name]
+        return 'stp_enable          : false' in ''.join(bridge.bridge_info())
+
+    def validate_enable_stp(self, dummy_result, switch_name):
+        """ Validate stp enable
+        """
+        bridge = self._bridges[switch_name]
+        return 'stp_enable          : true' in ''.join(bridge.bridge_info())