aboutsummaryrefslogtreecommitdiffstats
path: root/vswitches/ovs.py
blob: be7b77dfa8fa19551e84610dd19d47bb9a5a6606 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
# Copyright 2015-2018 Intel Corporation, Tieto and Others.
#
# 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.

"""VSPERF Open vSwitch base class
"""

import logging
import os
import re
import time
import datetime
import random
import pexpect

from conf import settings
from src.ovs import OFBridge, flow_key, flow_match
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.
    """
    _proc_name = 'ovs-vswitchd'

    def __init__(self):
        """See IVswitch for general description
        """
        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__)
        # sign '|' must be escaped or avoided, otherwise it is handled as 'or' by regex
        self._expect = r'bridge.INFO.{}'.format(self._proc_name)
        self._timeout = 30
        self._bridges = {}
        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):
        """ Start ``ovsdb-server`` and ``ovs-vswitchd`` instance.

        :raises: pexpect.EOF, pexpect.TIMEOUT
        """
        self._logger.info("Starting vswitchd...")

        # 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.")

    def restart(self):
        """ Restart ``ovs-vswitchd`` instance. ``ovsdb-server`` is not restarted.

        :raises: pexpect.EOF, pexpect.TIMEOUT
        """
        self._logger.info("Restarting vswitchd...")
        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)

        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.")

    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
        """
        for switch_name in list(self._bridges):
            self.del_switch(switch_name)
        self._logger.info("Terminating vswitchd...")
        self.kill()
        self._bridges = {}
        self._logger.info("Vswitchd...Terminated.")

    def add_switch(self, switch_name, params=None):
        """See IVswitch for general description
        """
        bridge = OFBridge(switch_name)
        bridge.create(params)
        bridge.set_db_attribute('Open_vSwitch', '.',
                                'other_config:max-idle',
                                settings.getValue('VSWITCH_FLOW_TIMEOUT'))
        self._bridges[switch_name] = bridge

    def del_switch(self, switch_name):
        """See IVswitch for general description
        """
        bridge = self._bridges[switch_name]
        bridge.del_flow({})
        for port in list(bridge.get_ports()):
            bridge.del_port(port)
        self._bridges.pop(switch_name)
        bridge.destroy()

    def add_phy_port(self, switch_name):
        """See IVswitch for general description
        """
        raise NotImplementedError

    def add_vport(self, switch_name):
        """See IVswitch for general description
        """
        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 None

        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
        """
        bridge = self._bridges[switch_name]
        pcount = str(self._get_port_count('type=' + tunnel_type))
        port_name = tunnel_type + pcount
        local_params = ['--', 'set', 'Interface', port_name,
                        'type=' + tunnel_type,
                        'options:remote_ip=' + remote_ip]

        if params is not None:
            local_params = local_params + params

        of_port = bridge.add_port(port_name, local_params)
        return (port_name, of_port)

    def get_ports(self, switch_name):
        """See IVswitch for general description
        """
        bridge = self._bridges[switch_name]
        ports = list(bridge.get_ports().items())
        return [(name, of_port) for (name, (of_port, _)) in ports]

    def del_port(self, switch_name, port_name):
        """See IVswitch for general description
        """
        bridge = self._bridges[switch_name]
        bridge.del_port(port_name)

    def add_flow(self, switch_name, flow, cache='off'):
        """See IVswitch for general description
        """
        bridge = self._bridges[switch_name]
        bridge.add_flow(flow, cache=cache)

    def del_flow(self, switch_name, flow=None):
        """See IVswitch for general description
        """
        flow = flow or {}
        bridge = self._bridges[switch_name]
        bridge.del_flow(flow)

    def dump_flows(self, switch_name):
        """See IVswitch for general description
        """
        bridge = self._bridges[switch_name]
        bridge.dump_flows()

    def add_route(self, switch_name, network, destination):
        """See IVswitch for general description
        """
        bridge = self._bridges[switch_name]
        bridge.add_route(network, destination)

    def set_tunnel_arp(self, ip_addr, mac_addr, switch_name):
        """See IVswitch for general description
        """
        bridge = self._bridges[switch_name]
        bridge.set_tunnel_arp(ip_addr, mac_addr, switch_name)

    def _get_port_count(self, param):
        """Returns the number of ports having a certain parameter
        """
        cnt = 0
        for k in self._bridges:
            pparams = [c for (_, (_, c)) in list(self._bridges[k].get_ports().items())]
            phits = [i for i in pparams if param in i]
            cnt += len(phits)

        if cnt is None:
            cnt = 0
        return cnt

    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: %s", 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]
        output = bridge.run_vsctl(['show'], check_error=True)
        assert not output[1]  # there shouldn't be any stderr, but in case
        assert re.search('Bridge ["\']?%s["\']?' % switch_name, output[0]) is not None
        return True

    # 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')
        output = bridge.run_vsctl(['show'], check_error=True)
        assert not output[1]  # there shouldn't be any stderr, but in case
        assert re.search('Bridge ["\']?%s["\']?' % switch_name, output[0]) is None
        return True

    def validate_add_phy_port(self, result, switch_name):
        """ Validate that physical port was added to bridge.
        """
        bridge = self._bridges[switch_name]
        output = bridge.run_vsctl(['show'], check_error=True)
        assert not output[1]  # there shouldn't be any stderr, but in case
        assert re.search('Port ["\']?%s["\']?' % result[0], output[0]) is not None
        assert re.search('Interface ["\']?%s["\']?' % result[0], output[0]) is not None
        return True

    def validate_add_vport(self, result, switch_name):
        """ Validate that virtual port was added to bridge.
        """
        return self.validate_add_phy_port(result, switch_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]
        output = bridge.run_vsctl(['show'], check_error=True)
        assert not output[1]  # there shouldn't be any stderr, but in case
        assert 'Port "%s"' % port_name not in output[0]
        return True

    def validate_add_flow(self, _dummy_result, switch_name, flow, _dummy_cache='off'):
        """ Validate insertion of the flow into the switch
        """

        if 'idle_timeout' in flow:
            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
        # as add-flow, so we have to compare it the hard way

        # get dump of flows and compare them one by one
        flow_src = flow_key(flow)
        bridge = self._bridges[switch_name]
        output = bridge.run_ofctl(['dump-flows', switch_name], check_error=True)
        for flow_dump in output[0].split('\n'):
            if flow_match(flow_dump, flow_src):
                # flow was added correctly
                return True
        return False

    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
        return not self.validate_add_flow(_dummy_result, switch_name, flow)

    def validate_dump_flows(self, _dummy_result, _dummy_switch_name):
        """ 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())

    def validate_restart(self, _dummy_result):
        """ Validate restart
        """
        return True