1 # Copyright (c) 2016-2017 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.
22 from yardstick import ssh
23 from yardstick.network_services.utils import get_nsb_option
24 from yardstick.benchmark.contexts.base import Context
25 from yardstick.benchmark.contexts.standalone import model
26 from yardstick.common import exceptions
27 from yardstick.network_services import utils
30 LOG = logging.getLogger(__name__)
35 class OvsDpdkContext(Context):
36 """ This class handles OVS standalone nodes - VM running on Non-Managed NFVi
37 Configuration: ovs_dpdk
40 __context_type__ = "StandaloneOvsDpdk"
42 SUPPORTED_OVS_TO_DPDK_MAP = {
53 DEFAULT_USER_PATH = '/usr/local'
59 self.dpdk_devbind = os.path.join(get_nsb_option('bin_path'),
68 self.helper = model.StandaloneContextHelper()
69 self.vnf_node = model.Server()
70 self.ovs_properties = {}
71 self.wait_for_vswitchd = 10
72 super(OvsDpdkContext, self).__init__()
74 def init(self, attrs):
75 """initializes itself from the supplied arguments"""
76 super(OvsDpdkContext, self).init(attrs)
78 self.file_path = attrs.get("file", "pod.yaml")
80 self.nodes, self.nfvi_host, self.host_mgmt = \
81 self.helper.parse_pod_file(self.file_path, 'OvsDpdk')
84 self.vm_flavor = attrs.get('flavor', {})
85 self.servers = attrs.get('servers', {})
86 self.vm_deploy = attrs.get("vm_deploy", True)
87 self.ovs_properties = attrs.get('ovs_properties', {})
88 # add optional static network definition
89 self.networks = attrs.get("networks", {})
91 LOG.debug("Nodes: %r", self.nodes)
92 LOG.debug("NFVi Node: %r", self.nfvi_host)
93 LOG.debug("Networks: %r", self.networks)
96 """Initialize OVS-DPDK"""
97 vpath = self.ovs_properties.get('vpath', self.DEFAULT_USER_PATH)
98 create_from = os.path.join(vpath, 'etc/openvswitch/conf.db')
99 create_to = os.path.join(vpath, 'share/openvswitch/vswitch.ovsschema')
102 'killall -r "ovs.*" -q | true',
103 'mkdir -p {0}/etc/openvswitch'.format(vpath),
104 'mkdir -p {0}/var/run/openvswitch'.format(vpath),
105 'rm {0}/etc/openvswitch/conf.db | true'.format(vpath),
106 'ovsdb-tool create {0} {1}'.format(create_from, create_to),
108 'chmod a+x /dev/vfio',
109 'chmod 0666 /dev/vfio/*',
112 bind_cmd = '%s --force -b vfio-pci {port}' % self.dpdk_devbind
113 for port in self.networks.values():
114 cmd_list.append(bind_cmd.format(port=port.get('phy_port')))
118 exit_status, _, stderr = self.connection.execute(
119 cmd, timeout=self.CMD_TIMEOUT)
121 raise exceptions.OVSSetupError(command=cmd, error=stderr)
123 def start_ovs_serverswitch(self):
124 vpath = self.ovs_properties.get("vpath")
125 pmd_nums = int(self.ovs_properties.get("pmd_threads", 2))
126 ovs_sock_path = '/var/run/openvswitch/db.sock'
127 log_path = '/var/log/openvswitch/ovs-vswitchd.log'
129 pmd_cpu_mask = self.ovs_properties.get("pmd_cpu_mask", '')
130 pmd_mask = hex(sum(2 ** num for num in range(pmd_nums)) << 1)
132 pmd_mask = pmd_cpu_mask
134 socket0 = self.ovs_properties.get("ram", {}).get("socket_0", "2048")
135 socket1 = self.ovs_properties.get("ram", {}).get("socket_1", "2048")
137 ovs_other_config = "ovs-vsctl {0}set Open_vSwitch . other_config:{1}"
138 detach_cmd = "ovs-vswitchd unix:{0}{1} --pidfile --detach --log-file={2}"
140 lcore_mask = self.ovs_properties.get("lcore_mask", '')
142 lcore_mask = ovs_other_config.format("--no-wait ", "dpdk-lcore-mask='%s'" % lcore_mask)
145 "mkdir -p /usr/local/var/run/openvswitch",
146 "mkdir -p {}".format(os.path.dirname(log_path)),
147 "ovsdb-server --remote=punix:/{0}/{1} --pidfile --detach".format(vpath,
149 ovs_other_config.format("--no-wait ", "dpdk-init=true"),
150 ovs_other_config.format("--no-wait ", "dpdk-socket-mem='%s,%s'" % (socket0, socket1)),
152 detach_cmd.format(vpath, ovs_sock_path, log_path),
153 ovs_other_config.format("", "pmd-cpu-mask=%s" % pmd_mask),
158 self.connection.execute(cmd)
159 time.sleep(self.wait_for_vswitchd)
161 def setup_ovs_bridge_add_flows(self):
164 vpath = self.ovs_properties.get("vpath", "/usr/local")
165 version = self.ovs_properties.get('version', {})
166 ovs_ver = [int(x) for x in version.get('ovs', self.DEFAULT_OVS).split('.')]
167 ovs_add_port = ('ovs-vsctl add-port {br} {port} -- '
168 'set Interface {port} type={type_}{dpdk_args}')
169 ovs_add_queue = 'ovs-vsctl set Interface {port} options:n_rxq={queue}'
170 chmod_vpath = 'chmod 0777 {0}/var/run/openvswitch/dpdkvhostuser*'
173 'ovs-vsctl --if-exists del-br {0}'.format(MAIN_BRIDGE),
174 'rm -rf {0}/var/run/openvswitch/dpdkvhostuser*'.format(vpath),
175 'ovs-vsctl add-br {0} -- set bridge {0} datapath_type=netdev'.
179 ordered_network = collections.OrderedDict(self.networks)
180 for index, vnf in enumerate(ordered_network.values()):
181 if ovs_ver >= [2, 7, 0]:
182 dpdk_args = " options:dpdk-devargs=%s" % vnf.get("phy_port")
183 dpdk_list.append(ovs_add_port.format(
184 br=MAIN_BRIDGE, port='dpdk%s' % vnf.get("port_num", 0),
185 type_='dpdk', dpdk_args=dpdk_args))
186 dpdk_list.append(ovs_add_queue.format(
187 port='dpdk%s' % vnf.get("port_num", 0),
188 queue=self.ovs_properties.get("queues", 1)))
190 # Sorting the array to make sure we execute dpdk0... in the order
192 cmd_list.extend(dpdk_list)
194 # Need to do two for loop to maintain the dpdk/vhost ports.
195 for index, _ in enumerate(ordered_network):
196 cmd_list.append(ovs_add_port.format(
197 br=MAIN_BRIDGE, port='dpdkvhostuser%s' % index,
198 type_='dpdkvhostuser', dpdk_args=""))
200 ovs_flow = ("ovs-ofctl add-flow {0} in_port=%s,action=output:%s".
202 network_count = len(ordered_network) + 1
203 for in_port, out_port in zip(range(1, network_count),
204 range(network_count, network_count * 2)):
205 cmd_list.append(ovs_flow % (in_port, out_port))
206 cmd_list.append(ovs_flow % (out_port, in_port))
208 cmd_list.append(chmod_vpath.format(vpath))
212 exit_status, _, stderr = self.connection.execute(
213 cmd, timeout=self.CMD_TIMEOUT)
215 raise exceptions.OVSSetupError(command=cmd, error=stderr)
217 def _check_hugepages(self):
218 meminfo = io.BytesIO()
219 self.connection.get_file_obj('/proc/meminfo', meminfo)
220 regex = re.compile(r"HugePages_Total:\s+(?P<hp_total>\d+)[\n\r]"
221 r"HugePages_Free:\s+(?P<hp_free>\d+)")
222 match = regex.search(meminfo.getvalue().decode('utf-8'))
224 raise exceptions.OVSHugepagesInfoError()
225 if int(match.group('hp_total')) == 0:
226 raise exceptions.OVSHugepagesNotConfigured()
227 if int(match.group('hp_free')) == 0:
228 raise exceptions.OVSHugepagesZeroFree(
229 total_hugepages=int(match.group('hp_total')))
231 def cleanup_ovs_dpdk_env(self):
232 self.connection.execute(
233 'ovs-vsctl --if-exists del-br {0}'.format(MAIN_BRIDGE))
234 self.connection.execute("pkill -9 ovs")
236 def check_ovs_dpdk_env(self):
237 self.cleanup_ovs_dpdk_env()
238 self._check_hugepages()
240 version = self.ovs_properties.get("version", {})
241 ovs_ver = version.get("ovs", self.DEFAULT_OVS)
242 dpdk_ver = version.get("dpdk", "16.07.2").split('.')
244 supported_version = self.SUPPORTED_OVS_TO_DPDK_MAP.get(ovs_ver, None)
245 if supported_version is None or supported_version.split('.')[:2] != dpdk_ver[:2]:
246 raise exceptions.OVSUnsupportedVersion(
248 ovs_to_dpdk_map=self.SUPPORTED_OVS_TO_DPDK_MAP)
250 status = self.connection.execute("ovs-vsctl -V | grep -i '%s'" % ovs_ver)[0]
252 deploy = model.OvsDeploy(self.connection,
253 utils.get_nsb_option("bin_path"),
258 """don't need to deploy"""
260 # Todo: NFVi deploy (sriov, vswitch, ovs etc) based on the config.
261 if not self.vm_deploy:
264 self.connection = ssh.SSH.from_node(self.host_mgmt)
266 # Check dpdk/ovs version, if not present install
267 self.check_ovs_dpdk_env()
268 # Todo: NFVi deploy (sriov, vswitch, ovs etc) based on the config.
269 model.StandaloneContextHelper.install_req_libs(self.connection)
270 self.networks = model.StandaloneContextHelper.get_nic_details(
271 self.connection, self.networks, self.dpdk_devbind)
274 self.start_ovs_serverswitch()
275 self.setup_ovs_bridge_add_flows()
276 self.nodes = self.setup_ovs_dpdk_context()
277 LOG.debug("Waiting for VM to come up...")
278 self.nodes = model.StandaloneContextHelper.wait_for_vnfs_to_start(
279 self.connection, self.servers, self.nodes)
283 if not self.vm_deploy:
286 # Cleanup the ovs installation...
287 self.cleanup_ovs_dpdk_env()
289 # Bind nics back to kernel
290 bind_cmd = "{dpdk_devbind} --force -b {driver} {port}"
291 for port in self.networks.values():
292 vpci = port.get("phy_port")
293 phy_driver = port.get("driver")
294 self.connection.execute(bind_cmd.format(
295 dpdk_devbind=self.dpdk_devbind, driver=phy_driver, port=vpci))
297 # Todo: NFVi undeploy (sriov, vswitch, ovs etc) based on the config.
298 for vm in self.vm_names:
299 model.Libvirt.check_if_vm_exists_and_delete(vm, self.connection)
301 def _get_server(self, attr_name):
302 """lookup server info by name from context
305 attr_name -- A name for a server listed in nodes config file
307 node_name, name = self.split_host_name(attr_name)
308 if name is None or self.name != name:
311 matching_nodes = (n for n in self.nodes if n["name"] == node_name)
313 # A clone is created in order to avoid affecting the
315 node = dict(next(matching_nodes))
316 except StopIteration:
320 duplicate = next(matching_nodes)
321 except StopIteration:
324 raise ValueError("Duplicate nodes!!! Nodes: %s %s" % (node, duplicate))
326 node["name"] = attr_name
329 def _get_network(self, attr_name):
330 if not isinstance(attr_name, collections.Mapping):
331 network = self.networks.get(attr_name)
334 # Don't generalize too much Just support vld_id
335 vld_id = attr_name.get('vld_id', {})
336 # for standalone context networks are dicts
337 iter1 = (n for n in self.networks.values() if n.get('vld_id') == vld_id)
338 network = next(iter1, None)
345 "name": network["name"],
346 "vld_id": network.get("vld_id"),
347 "segmentation_id": network.get("segmentation_id"),
348 "network_type": network.get("network_type"),
349 "physical_network": network.get("physical_network"),
353 def configure_nics_for_ovs_dpdk(self):
354 portlist = collections.OrderedDict(self.networks)
356 mac = model.StandaloneContextHelper.get_mac_address()
357 portlist[key].update({'mac': mac})
358 self.networks = portlist
359 LOG.info("Ports %s", self.networks)
361 def _enable_interfaces(self, index, vfs, xml_str):
362 vpath = self.ovs_properties.get("vpath", "/usr/local")
363 vf = self.networks[vfs[0]]
364 port_num = vf.get('port_num', 0)
365 vpci = utils.PciAddress(vf['vpci'].strip())
366 # Generate the vpci for the interfaces
367 slot = index + port_num + 10
369 "{}:{}:{:02x}.{}".format(vpci.domain, vpci.bus, slot, vpci.function)
370 return model.Libvirt.add_ovs_interface(
371 vpath, port_num, vf['vpci'], vf['mac'], xml_str)
373 def setup_ovs_dpdk_context(self):
376 self.configure_nics_for_ovs_dpdk()
378 for index, (key, vnf) in enumerate(collections.OrderedDict(
379 self.servers).items()):
380 cfg = '/tmp/vm_ovs_%d.xml' % index
381 vm_name = "vm_%d" % index
383 # 1. Check and delete VM if already exists
384 model.Libvirt.check_if_vm_exists_and_delete(vm_name,
386 xml_str, mac = model.Libvirt.build_vm_xml(
387 self.connection, self.vm_flavor, vm_name, index)
389 # 2: Cleanup already available VMs
390 for vfs in [vfs for vfs_name, vfs in vnf["network_ports"].items()
391 if vfs_name != 'mgmt']:
392 xml_str = self._enable_interfaces(index, vfs, xml_str)
394 # copy xml to target...
395 model.Libvirt.write_file(cfg, xml_str)
396 self.connection.put(cfg, cfg)
398 # NOTE: launch through libvirt
399 LOG.info("virsh create ...")
400 model.Libvirt.virsh_create_vm(self.connection, cfg)
402 self.vm_names.append(vm_name)
404 # build vnf node details
405 nodes.append(self.vnf_node.generate_vnf_instance(self.vm_flavor,
407 self.host_mgmt.get('ip'),