1 # Copyright 2015-2016 Intel Corporation.
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
15 """VSPERF Open vSwitch base class
24 from conf import settings
25 from src.ovs import OFBridge, flow_key, flow_match
26 from tools import tasks
27 from vswitches.vswitch import IVSwitch
29 _OVS_VAR_DIR = settings.getValue('OVS_VAR_DIR')
30 _OVS_ETC_DIR = settings.getValue('OVS_ETC_DIR')
33 class IVSwitchOvs(IVSwitch, tasks.Process):
34 """Open vSwitch base class implementation
36 The method docstrings document only considerations specific to this
37 implementation. For generic information of the nature of the methods,
40 _logfile = os.path.join(settings.getValue('LOG_DIR'), settings.getValue('LOG_FILE_VSWITCHD'))
41 _ovsdb_pidfile_path = os.path.join(settings.getValue('LOG_DIR'), "ovsdb_pidfile.pid")
42 _vswitchd_pidfile_path = os.path.join(settings.getValue('LOG_DIR'), "vswitchd_pidfile.pid")
43 _proc_name = 'ovs-vswitchd'
46 """See IVswitch for general description
48 self._logger = logging.getLogger(__name__)
52 self._vswitchd_args = ['--pidfile=' + self._vswitchd_pidfile_path,
53 '--overwrite-pidfile', '--log-file=' + self._logfile]
55 self._cmd_template = ['sudo', '-E', os.path.join(settings.getValue('OVS_DIR'),
56 'vswitchd', 'ovs-vswitchd')]
59 """ Start ``ovsdb-server`` and ``ovs-vswitchd`` instance.
61 :raises: pexpect.EOF, pexpect.TIMEOUT
63 self._logger.info("Starting vswitchd...")
65 self._cmd = self._cmd_template + self._vswitchd_args
67 # DB must be started before vswitchd
71 # DB must be up before vswitchd config is altered or vswitchd started
77 tasks.Process.start(self)
79 except (pexpect.EOF, pexpect.TIMEOUT) as exc:
80 logging.error("Exception during VSwitch start.")
84 self._logger.info("Vswitchd...Started.")
87 """ Configure vswitchd through ovsdb if needed
92 """See IVswitch for general description
94 self._logger.info("Terminating vswitchd...")
96 self._logger.info("Vswitchd...Terminated.")
98 def add_switch(self, switch_name, params=None):
99 """See IVswitch for general description
101 bridge = OFBridge(switch_name)
102 bridge.create(params)
103 bridge.set_db_attribute('Open_vSwitch', '.',
104 'other_config:max-idle',
105 settings.getValue('VSWITCH_FLOW_TIMEOUT'))
106 self._bridges[switch_name] = bridge
108 def del_switch(self, switch_name):
109 """See IVswitch for general description
111 bridge = self._bridges[switch_name]
112 self._bridges.pop(switch_name)
115 def add_phy_port(self, switch_name):
116 """See IVswitch for general description
118 raise NotImplementedError
120 def add_vport(self, switch_name):
121 """See IVswitch for general description
123 raise NotImplementedError
125 def add_tunnel_port(self, switch_name, remote_ip, tunnel_type='vxlan', params=None):
126 """Creates tunneling port
128 bridge = self._bridges[switch_name]
129 pcount = str(self._get_port_count('type=' + tunnel_type))
130 port_name = tunnel_type + pcount
131 local_params = ['--', 'set', 'Interface', port_name,
132 'type=' + tunnel_type,
133 'options:remote_ip=' + remote_ip]
135 if params is not None:
136 local_params = local_params + params
138 of_port = bridge.add_port(port_name, local_params)
139 return (port_name, of_port)
141 def get_ports(self, switch_name):
142 """See IVswitch for general description
144 bridge = self._bridges[switch_name]
145 ports = list(bridge.get_ports().items())
146 return [(name, of_port) for (name, (of_port, _)) in ports]
148 def del_port(self, switch_name, port_name):
149 """See IVswitch for general description
151 bridge = self._bridges[switch_name]
152 bridge.del_port(port_name)
154 def add_flow(self, switch_name, flow, cache='off'):
155 """See IVswitch for general description
157 bridge = self._bridges[switch_name]
158 bridge.add_flow(flow, cache=cache)
160 def del_flow(self, switch_name, flow=None):
161 """See IVswitch for general description
164 bridge = self._bridges[switch_name]
165 bridge.del_flow(flow)
167 def dump_flows(self, switch_name):
168 """See IVswitch for general description
170 bridge = self._bridges[switch_name]
173 def add_route(self, switch_name, network, destination):
174 """See IVswitch for general description
176 bridge = self._bridges[switch_name]
177 bridge.add_route(network, destination)
179 def set_tunnel_arp(self, ip_addr, mac_addr, switch_name):
180 """See IVswitch for general description
182 bridge = self._bridges[switch_name]
183 bridge.set_tunnel_arp(ip_addr, mac_addr, switch_name)
185 def _get_port_count(self, param):
186 """Returns the number of ports having a certain parameter
189 for k in self._bridges:
190 pparams = [c for (_, (_, c)) in list(self._bridges[k].get_ports().items())]
191 phits = [i for i in pparams if param in i]
198 def disable_stp(self, switch_name):
200 Disable stp protocol on the bridge
201 :param switch_name: bridge to disable stp
204 bridge = self._bridges[switch_name]
205 bridge.set_stp(False)
206 self._logger.info('Sleeping for 50 secs to allow stp to stop.')
207 time.sleep(50) # needs time to disable
209 def enable_stp(self, switch_name):
211 Enable stp protocol on the bridge
212 :param switch_name: bridge to enable stp
215 bridge = self._bridges[switch_name]
217 self._logger.info('Sleeping for 50 secs to allow stp to start.')
218 time.sleep(50) # needs time to enable
220 def disable_rstp(self, switch_name):
222 Disable rstp on the bridge
223 :param switch_name: bridge to disable rstp
226 bridge = self._bridges[switch_name]
227 bridge.set_rstp(False)
228 self._logger.info('Sleeping for 15 secs to allow rstp to stop.')
229 time.sleep(15) # needs time to disable
231 def enable_rstp(self, switch_name):
233 Enable rstp on the bridge
234 :param switch_name: bridge to enable rstp
237 bridge = self._bridges[switch_name]
238 bridge.set_rstp(True)
239 self._logger.info('Sleeping for 15 secs to allow rstp to start.')
240 time.sleep(15) # needs time to enable
242 def kill(self, signal='-15', sleep=10):
243 """Kill ``ovs-vswitchd`` and ``ovs-ovsdb`` instances if they are alive.
247 if os.path.isfile(self._vswitchd_pidfile_path):
248 self._logger.info('Killing ovs-vswitchd...')
249 with open(self._vswitchd_pidfile_path, "r") as pidfile:
250 vswitchd_pid = pidfile.read().strip()
251 tasks.terminate_task(vswitchd_pid, logger=self._logger)
253 self._kill_ovsdb() # ovsdb must be killed after vswitchd
255 # just for case, that sudo envelope has not been terminated yet
256 tasks.Process.kill(self, signal, sleep)
260 def _reset_ovsdb(self):
261 """Reset system for 'ovsdb'.
265 self._logger.info('Resetting system after last run...')
267 tasks.run_task(['sudo', 'rm', '-rf', _OVS_VAR_DIR], self._logger)
268 tasks.run_task(['sudo', 'mkdir', '-p', _OVS_VAR_DIR], self._logger)
269 tasks.run_task(['sudo', 'rm', '-rf', _OVS_ETC_DIR], self._logger)
270 tasks.run_task(['sudo', 'mkdir', '-p', _OVS_ETC_DIR], self._logger)
272 tasks.run_task(['sudo', 'rm', '-f',
273 os.path.join(_OVS_ETC_DIR, 'conf.db')],
276 self._logger.info('System reset after last run.')
278 def _start_ovsdb(self):
279 """Start ``ovsdb-server`` instance.
283 ovsdb_tool_bin = os.path.join(
284 settings.getValue('OVS_DIR'), 'ovsdb', 'ovsdb-tool')
285 tasks.run_task(['sudo', ovsdb_tool_bin, 'create',
286 os.path.join(_OVS_ETC_DIR, 'conf.db'),
287 os.path.join(settings.getValue('OVS_DIR'), 'vswitchd',
288 'vswitch.ovsschema')],
290 'Creating ovsdb configuration database...')
292 ovsdb_server_bin = os.path.join(
293 settings.getValue('OVS_DIR'), 'ovsdb', 'ovsdb-server')
295 tasks.run_background_task(
296 ['sudo', ovsdb_server_bin,
297 '--remote=punix:%s' % os.path.join(_OVS_VAR_DIR, 'db.sock'),
298 '--remote=db:Open_vSwitch,Open_vSwitch,manager_options',
299 '--pidfile=' + self._ovsdb_pidfile_path, '--overwrite-pidfile'],
301 'Starting ovsdb-server...')
303 def _kill_ovsdb(self):
304 """Kill ``ovsdb-server`` instance.
308 if os.path.isfile(self._ovsdb_pidfile_path):
309 with open(self._ovsdb_pidfile_path, "r") as pidfile:
310 ovsdb_pid = pidfile.read().strip()
312 self._logger.info("Killing ovsdb with pid: " + ovsdb_pid)
315 tasks.terminate_task(ovsdb_pid, logger=self._logger)
318 def get_db_sock_path():
319 """Method returns location of db.sock file
321 :returns: path to db.sock file.
323 return os.path.join(_OVS_VAR_DIR, 'db.sock')
326 # validate methods required for integration testcases
329 def validate_add_switch(self, result, switch_name, params=None):
330 """Validate - Create a new logical switch with no ports
332 bridge = self._bridges[switch_name]
333 output = bridge.run_vsctl(['show'], check_error=True)
334 assert not output[1] # there shouldn't be any stderr, but in case
335 assert re.search('Bridge ["\']?%s["\']?' % switch_name, output[0]) is not None
338 def validate_del_switch(self, result, switch_name):
339 """Validate removal of switch
341 bridge = OFBridge('tmp')
342 output = bridge.run_vsctl(['show'], check_error=True)
343 assert not output[1] # there shouldn't be any stderr, but in case
344 assert re.search('Bridge ["\']?%s["\']?' % switch_name, output[0]) is None
347 def validate_add_phy_port(self, result, switch_name):
348 """ Validate that physical port was added to bridge.
350 bridge = self._bridges[switch_name]
351 output = bridge.run_vsctl(['show'], check_error=True)
352 assert not output[1] # there shouldn't be any stderr, but in case
353 assert re.search('Port ["\']?%s["\']?' % result[0], output[0]) is not None
354 assert re.search('Interface ["\']?%s["\']?' % result[0], output[0]) is not None
357 def validate_add_vport(self, result, switch_name):
358 """ Validate that virtual port was added to bridge.
360 return self.validate_add_phy_port(result, switch_name)
362 def validate_del_port(self, result, switch_name, port_name):
363 """ Validate that port_name was removed from bridge.
365 bridge = self._bridges[switch_name]
366 output = bridge.run_vsctl(['show'], check_error=True)
367 assert not output[1] # there shouldn't be any stderr, but in case
368 assert 'Port "%s"' % port_name not in output[0]
371 def validate_add_flow(self, result, switch_name, flow, cache='off'):
372 """ Validate insertion of the flow into the switch
374 if 'idle_timeout' in flow:
375 del(flow['idle_timeout'])
377 # Note: it should be possible to call `ovs-ofctl dump-flows switch flow`
378 # to verify flow insertion, but it doesn't accept the same flow syntax
379 # as add-flow, so we have to compare it the hard way
381 # get dump of flows and compare them one by one
382 flow_src = flow_key(flow)
383 bridge = self._bridges[switch_name]
384 output = bridge.run_ofctl(['dump-flows', switch_name], check_error=True)
385 for flow_dump in output[0].split('\n'):
386 if flow_match(flow_dump, flow_src):
387 # flow was added correctly
391 def validate_del_flow(self, result, switch_name, flow=None):
392 """ Validate removal of the flow
395 # what else we can do?
397 return not self.validate_add_flow(result, switch_name, flow)
399 def validate_dump_flows(self, result, switch_name):
400 """ Validate call of flow dump
404 def validate_disable_rstp(self, result, switch_name):
405 """ Validate rstp disable
407 bridge = self._bridges[switch_name]
408 return 'rstp_enable : false' in ''.join(bridge.bridge_info())
410 def validate_enable_rstp(self, result, switch_name):
411 """ Validate rstp enable
413 bridge = self._bridges[switch_name]
414 return 'rstp_enable : true' in ''.join(bridge.bridge_info())
416 def validate_disable_stp(self, result, switch_name):
417 """ Validate stp disable
419 bridge = self._bridges[switch_name]
420 return 'stp_enable : false' in ''.join(bridge.bridge_info())
422 def validate_enable_stp(self, result, switch_name):
423 """ Validate stp enable
425 bridge = self._bridges[switch_name]
426 return 'stp_enable : true' in ''.join(bridge.bridge_info())