src/ovs/ofctl.py

   1 # Copyright 2015-2017 Intel Corporation.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #   http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 """Wrapper for an OVS bridge for convenient use of ``ovs-vsctl`` and
  16 ``ovs-ofctl`` on it.
  17
  18 Much of this code is based on ``ovs-lib.py`` from Open Stack:
  19
  20 https://github.com/openstack/neutron/blob/6eac1dc99124ca024d6a69b3abfa3bc69c735667/neutron/agent/linux/ovs_lib.py
  21 """
  22 import logging
  23 import string
  24 import re
  25 import netaddr
  26
  27 from tools import tasks
  28 from conf import settings as S
  29
  30 _OVS_BRIDGE_NAME = S.getValue('VSWITCH_BRIDGE_NAME')
  31 _OVS_CMD_TIMEOUT = S.getValue('OVS_CMD_TIMEOUT')
  32
  33 _CACHE_FILE_NAME = '/tmp/vsperf_flows_cache'
  34
  35 # only simple regex is used; validity of IPv4 is not checked by regex
  36 _IPV4_REGEX = r"([0-9]{1,3}(\.[0-9]{1,3}){3}(\/[0-9]{1,2})?)"
  37
  38 class OFBase(object):
  39     """Add/remove/show datapaths using ``ovs-ofctl``.
  40     """
  41     def __init__(self, timeout=_OVS_CMD_TIMEOUT):
  42         """Initialise logger.
  43
  44         :param timeout: Timeout to be used for each command
  45
  46         :returns: None
  47         """
  48         self.logger = logging.getLogger(__name__)
  49         self.timeout = timeout
  50
  51     # helpers
  52
  53     def run_vsctl(self, args, check_error=False):
  54         """Run ``ovs-vsctl`` with supplied arguments.
  55
  56         In case that timeout is set to -1, then ovs-vsctl
  57         will be called with --no-wait option.
  58
  59         :param args: Arguments to pass to ``ovs-vsctl``
  60         :param check_error: Throw exception on error
  61
  62         :return: None
  63         """
  64         if self.timeout == -1:
  65             cmd = ['sudo', S.getValue('TOOLS')['ovs-vsctl'], '--no-wait'] + \
  66                   S.getValue('OVS_VSCTL_ARGS') + args
  67         else:
  68             cmd = ['sudo', S.getValue('TOOLS')['ovs-vsctl'], '--timeout',
  69                    str(self.timeout)] + S.getValue('OVS_VSCTL_ARGS') + args
  70         return tasks.run_task(
  71             cmd, self.logger, 'Running ovs-vsctl...', check_error)
  72
  73
  74     def run_appctl(self, args, check_error=False):
  75         """Run ``ovs-appctl`` with supplied arguments.
  76
  77         :param args: Arguments to pass to ``ovs-appctl``
  78         :param check_error: Throw exception on error
  79
  80         :return: None
  81         """
  82         cmd = ['sudo', S.getValue('TOOLS')['ovs-appctl'],
  83                '--timeout',
  84                str(self.timeout)] + S.getValue('OVS_APPCTL_ARGS') + args
  85         return tasks.run_task(
  86             cmd, self.logger, 'Running ovs-appctl...', check_error)
  87
  88
  89     # datapath management
  90
  91     def add_br(self, br_name=_OVS_BRIDGE_NAME, params=None):
  92         """Add datapath.
  93
  94         :param br_name: Name of bridge
  95
  96         :return: Instance of :class OFBridge:
  97         """
  98         if params is None:
  99             params = []
 100
 101         self.logger.debug('add bridge')
 102         self.run_vsctl(['add-br', br_name]+params)
 103
 104         return OFBridge(br_name, self.timeout)
 105
 106     def del_br(self, br_name=_OVS_BRIDGE_NAME):
 107         """Delete datapath.
 108
 109         :param br_name: Name of bridge
 110
 111         :return: None
 112         """
 113         self.logger.debug('delete bridge')
 114         self.run_vsctl(['del-br', br_name])
 115
 116     # Route and ARP functions
 117
 118     def add_route(self, network, destination):
 119         """Add route to tunneling routing table.
 120
 121         :param network: Network
 122         :param destination: Gateway
 123
 124         :return: None
 125         """
 126         self.logger.debug('add ovs/route')
 127         self.run_appctl(['ovs/route/add', network, destination])
 128
 129
 130     def set_tunnel_arp(self, ip_addr, mac_addr, br_name=_OVS_BRIDGE_NAME):
 131         """Add OVS arp entry for tunneling
 132
 133         :param ip: IP of bridge
 134         :param mac_addr: MAC address of the bridge
 135         :param br_name: Name of the bridge
 136
 137         :return: None
 138         """
 139         self.logger.debug('tnl/arp/set')
 140         self.run_appctl(['tnl/arp/set', br_name, ip_addr, mac_addr])
 141
 142
 143 class OFBridge(OFBase):
 144     """Control a bridge instance using ``ovs-vsctl`` and ``ovs-ofctl``.
 145     """
 146     def __init__(self, br_name=_OVS_BRIDGE_NAME, timeout=_OVS_CMD_TIMEOUT):
 147         """Initialise bridge.
 148
 149         :param br_name: Bridge name
 150         :param timeout: Timeout to be used for each command
 151
 152         :returns: None
 153         """
 154         super(OFBridge, self).__init__(timeout)
 155         self.br_name = br_name
 156         self._ports = {}
 157         self._cache_file = None
 158
 159     # helpers
 160
 161     def run_ofctl(self, args, check_error=False, timeout=None):
 162         """Run ``ovs-ofctl`` with supplied arguments.
 163
 164         :param args: Arguments to pass to ``ovs-ofctl``
 165         :param check_error: Throw exception on error
 166
 167         :return: None
 168         """
 169         tmp_timeout = self.timeout if timeout is None else timeout
 170         cmd = ['sudo', S.getValue('TOOLS')['ovs-ofctl'], '--timeout',
 171                str(tmp_timeout)] + S.getValue('OVS_OFCTL_ARGS') + args
 172         return tasks.run_task(
 173             cmd, self.logger, 'Running ovs-ofctl...', check_error)
 174
 175     def create(self, params=None):
 176         """Create bridge.
 177         """
 178         if params is None:
 179             params = []
 180
 181         self.logger.debug('create bridge')
 182         self.add_br(self.br_name, params=params)
 183
 184     def destroy(self):
 185         """Destroy bridge.
 186         """
 187         self.logger.debug('destroy bridge')
 188         self.del_br(self.br_name)
 189
 190     def reset(self):
 191         """Reset bridge.
 192         """
 193         self.logger.debug('reset bridge')
 194         self.destroy()
 195         self.create()
 196
 197     # port management
 198
 199     def add_port(self, port_name, params):
 200         """Add port to bridge.
 201
 202         :param port_name: Name of port
 203         :param params: Additional list of parameters to add-port
 204
 205         :return: OpenFlow port number for the port
 206         """
 207         self.logger.debug('add port')
 208         self.run_vsctl(['add-port', self.br_name, port_name]+params)
 209
 210         # This is how port number allocation works currently
 211         # This possibly will not work correctly if there are port deletions
 212         # in between
 213         of_port = len(self._ports) + 1
 214         self._ports[port_name] = (of_port, params)
 215         return of_port
 216
 217     def del_port(self, port_name):
 218         """Remove port from bridge.
 219
 220         :param port_name: Name of port
 221
 222         :return: None
 223         """
 224         self.logger.debug('delete port')
 225         self.run_vsctl(['del-port', self.br_name, port_name])
 226         self._ports.pop(port_name)
 227
 228     def set_db_attribute(self, table_name, record, column, value):
 229         """Set database attribute.
 230
 231         :param table_name: Name of table
 232         :param record: Name of record
 233         :param column: Name of column
 234         :param value: Value to set
 235
 236         :return: None
 237         """
 238         self.logger.debug('set attribute')
 239         self.run_vsctl(['set', table_name, record, '%s=%s' % (column, value)])
 240
 241     def get_ports(self):
 242         """Get the ports of this bridge
 243
 244         Structure of the returned ports dictionary is
 245         'portname': (openflow_port_number, extra_parameters)
 246
 247         Example:
 248         ports = {
 249             'dpdkport0':
 250                 (1, ['--', 'set', 'Interface', 'dpdkport0', 'type=dpdk']),
 251             'dpdkvhostport0':
 252                 (2, ['--', 'set', 'Interface', 'dpdkvhostport0',
 253                      'type=dpdkvhost'])
 254         }
 255
 256         :return: Dictionary of ports
 257         """
 258         return self._ports
 259
 260     def clear_db_attribute(self, table_name, record, column):
 261         """Clear database attribute.
 262
 263         :param table_name: Name of table
 264         :param record: Name of record
 265         :param column: Name of column
 266
 267         :return: None
 268         """
 269         self.logger.debug('clear attribute')
 270         self.run_vsctl(['clear', table_name, record, column])
 271
 272     # flow mangement
 273
 274     def add_flow(self, flow, cache='off'):
 275         """Add flow to bridge.
 276
 277         :param flow: Flow description as a dictionary
 278         For flow dictionary structure, see function flow_key
 279
 280         :return: None
 281         """
 282         # insert flows from cache into OVS if needed
 283         if cache == 'flush':
 284             if self._cache_file is None:
 285                 self.logger.error('flow cache flush called, but nothing is cached')
 286                 return
 287             self.logger.debug('flows cached in %s will be added to the bridge', _CACHE_FILE_NAME)
 288             self._cache_file.close()
 289             self._cache_file = None
 290             self.run_ofctl(['add-flows', self.br_name, _CACHE_FILE_NAME], timeout=600)
 291             return
 292
 293         if not flow.get('actions'):
 294             self.logger.error('add flow requires actions')
 295             return
 296
 297         _flow_key = flow_key(flow)
 298         self.logger.debug('key : %s', _flow_key)
 299
 300         # insert flow to the cache or OVS
 301         if cache == 'on':
 302             # create and open cache file if needed
 303             if self._cache_file is None:
 304                 self._cache_file = open(_CACHE_FILE_NAME, 'w')
 305             self._cache_file.write(_flow_key + '\n')
 306         else:
 307             self.run_ofctl(['add-flow', self.br_name, _flow_key])
 308
 309     def del_flow(self, flow):
 310         """Delete flow from bridge.
 311
 312         :param flow: Flow description as a dictionary
 313         For flow dictionary structure, see function flow_key
 314         flow=None will delete all flows
 315
 316         :return: None
 317         """
 318         self.logger.debug('delete flow')
 319         _flow_key = flow_key(flow)
 320         self.logger.debug('key : %s', _flow_key)
 321         self.run_ofctl(['del-flows', self.br_name, _flow_key])
 322
 323     def del_flows(self):
 324         """Delete all flows from bridge.
 325         """
 326         self.logger.debug('delete flows')
 327         self.run_ofctl(['del-flows', self.br_name])
 328
 329     def dump_flows(self):
 330         """Dump all flows from bridge.
 331         """
 332         self.logger.debug('dump flows')
 333         self.run_ofctl(['dump-flows', self.br_name], timeout=120)
 334
 335     def set_stp(self, enable=True):
 336         """
 337         Set stp status
 338         :param enable: Boolean to enable or disable stp
 339         :return: None
 340         """
 341         self.logger.debug(
 342             'Setting stp on bridge to %s', 'on' if enable else 'off')
 343         self.run_vsctl(
 344             ['set', 'Bridge', self.br_name, 'stp_enable={}'.format(
 345                 'true' if enable else 'false')])
 346
 347     def set_rstp(self, enable=True):
 348         """
 349         Set rstp status
 350         :param enable: Boolean to enable or disable rstp
 351         :return: None
 352         """
 353         self.logger.debug(
 354             'Setting rstp on bridge to %s', 'on' if enable else 'off')
 355         self.run_vsctl(
 356             ['set', 'Bridge', self.br_name, 'rstp_enable={}'.format(
 357                 'true' if enable else 'false')])
 358
 359     def bridge_info(self):
 360         """
 361         Get bridge info
 362         :return: Returns bridge info from list bridge command
 363         """
 364         return self.run_vsctl(['list', 'bridge', self.br_name])
 365
 366 #
 367 # helper functions
 368 #
 369
 370 def flow_key(flow):
 371     """Model a flow key string for ``ovs-ofctl``.
 372
 373     Syntax taken from ``ovs-ofctl`` manpages:
 374         http://openvswitch.org/cgi-bin/ovsman.cgi?page=utilities%2Fovs-ofctl.8
 375
 376     Example flow dictionary:
 377     flow = {
 378         'in_port': '1',
 379         'idle_timeout': '0',
 380         'actions': ['output:3']
 381     }
 382
 383     :param flow: Flow description as a dictionary
 384
 385     :return: String
 386     :rtype: str
 387     """
 388     _flow_add_key = string.Template('${fields},action=${actions}')
 389     _flow_del_key = string.Template('${fields}')
 390
 391     field_params = []
 392
 393     user_params = (x for x in list(flow.items()) if x[0] != 'actions')
 394     for (key, default) in user_params:
 395         field_params.append('%(field)s=%(value)s' %
 396                             {'field': key, 'value': default})
 397
 398     field_params_str = ','.join(field_params)
 399
 400     _flow_key_param = {
 401         'fields': field_params_str,
 402     }
 403
 404     # no actions == delete key
 405     if 'actions' in flow:
 406         _flow_key_param['actions'] = ','.join(flow['actions'])
 407
 408         flow_str = _flow_add_key.substitute(_flow_key_param)
 409     else:
 410         flow_str = _flow_del_key.substitute(_flow_key_param)
 411
 412     return flow_str
 413
 414 def flow_match(flow_dump, flow_src):
 415     """ Compares two flows
 416
 417     :param flow_dump: string - a string with flow obtained by ovs-ofctl dump-flows
 418     :param flow_src: string - a string with flow obtained by call of flow_key()
 419
 420     :return: boolean
 421     """
 422     # perform unifications on both source and destination flows
 423     flow_dump = flow_dump.replace('actions=', 'action=')
 424     flow_src = flow_src.replace('actions=', 'action=')
 425     # For complex flows the output of "ovs-ofctl dump-flows" can use the
 426     # shorthand notation.
 427     # eg if we set a flow with constraints on UDP ports like in the following
 428     # {'dl_type': '0x0800', 'nw_proto': '17', 'in_port': '1', 'udp_dst': '0', 'actions': ['output:2']}
 429     # dump-flows output can combine the first 2 constraints into 'udp' and translate
 430     # 'udp_dst' into 'tp_dst' like
 431     # "udp,in_port=1,tp_dst=0 actions=output:2".
 432     # So the next replacements are needed.
 433     flow_dump = flow_dump.replace('ip', 'dl_type=0x0800')
 434     flow_dump = flow_dump.replace('tcp', 'nw_proto=6,dl_type=0x0800')
 435     flow_dump = flow_dump.replace('udp', 'nw_proto=17,dl_type=0x0800')
 436     flow_src = flow_src.replace('udp_src', 'tp_src')
 437     flow_src = flow_src.replace('udp_dst', 'tp_dst')
 438     flow_src = flow_src.replace('tcp_src', 'tp_src')
 439     flow_src = flow_src.replace('tcp_dst', 'tp_dst')
 440     flow_src = flow_src.replace('0x800', '0x0800')
 441
 442     # modify IPv4 CIDR to real network addresses
 443     for ipv4_cidr in re.findall(_IPV4_REGEX, flow_src):
 444         if ipv4_cidr[2]:
 445             tmp_cidr = str(netaddr.IPNetwork(ipv4_cidr[0]).cidr)
 446             flow_src = flow_src.replace(ipv4_cidr[0], tmp_cidr)
 447
 448     # split flow strings into lists of comparable elements
 449     flow_dump_list = re.findall(r"[\w.:=()/]+", flow_dump)
 450     flow_src_list = re.findall(r"[\w.:=()/]+", flow_src)
 451
 452     # check if all items from source flow are present in dump flow
 453     flow_src_ctrl = list(flow_src_list)
 454     for rule in flow_src_list:
 455         if rule in flow_dump_list:
 456             flow_src_ctrl.remove(rule)
 457     return True if not flow_src_ctrl else False