yardstick/benchmark/contexts/standalone/ovs_dpdk.py

   1 # Copyright (c) 2016-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 from __future__ import absolute_import
  16 import os
  17 import logging
  18 import collections
  19 import time
  20
  21 from collections import OrderedDict
  22
  23 from yardstick import ssh
  24 from yardstick.network_services.utils import get_nsb_option
  25 from yardstick.network_services.utils import provision_tool
  26 from yardstick.benchmark.contexts.base import Context
  27 from yardstick.benchmark.contexts.standalone.model import Libvirt
  28 from yardstick.benchmark.contexts.standalone.model import StandaloneContextHelper
  29 from yardstick.benchmark.contexts.standalone.model import Server
  30 from yardstick.benchmark.contexts.standalone.model import OvsDeploy
  31 from yardstick.network_services.utils import PciAddress
  32
  33 LOG = logging.getLogger(__name__)
  34
  35
  36 class OvsDpdkContext(Context):
  37     """ This class handles OVS standalone nodes - VM running on Non-Managed NFVi
  38     Configuration: ovs_dpdk
  39     """
  40
  41     __context_type__ = "StandaloneOvsDpdk"
  42
  43     SUPPORTED_OVS_TO_DPDK_MAP = {
  44         '2.6.0': '16.07.1',
  45         '2.6.1': '16.07.2',
  46         '2.7.0': '16.11.1',
  47         '2.7.1': '16.11.2',
  48         '2.7.2': '16.11.3',
  49         '2.8.0': '17.05.2'
  50     }
  51
  52     DEFAULT_OVS = '2.6.0'
  53
  54     PKILL_TEMPLATE = "pkill %s %s"
  55
  56     def __init__(self):
  57         self.file_path = None
  58         self.sriov = []
  59         self.first_run = True
  60         self.dpdk_nic_bind = ""
  61         self.vm_names = []
  62         self.name = None
  63         self.nfvi_host = []
  64         self.nodes = []
  65         self.networks = {}
  66         self.attrs = {}
  67         self.vm_flavor = None
  68         self.servers = None
  69         self.helper = StandaloneContextHelper()
  70         self.vnf_node = Server()
  71         self.ovs_properties = {}
  72         self.wait_for_vswitchd = 10
  73         super(OvsDpdkContext, self).__init__()
  74
  75     def init(self, attrs):
  76         """initializes itself from the supplied arguments"""
  77
  78         self.name = attrs["name"]
  79         self.file_path = attrs.get("file", "pod.yaml")
  80
  81         self.nodes, self.nfvi_host, self.host_mgmt = \
  82             self.helper.parse_pod_file(self.file_path, 'OvsDpdk')
  83
  84         self.attrs = attrs
  85         self.vm_flavor = attrs.get('flavor', {})
  86         self.servers = attrs.get('servers', {})
  87         self.vm_deploy = attrs.get("vm_deploy", True)
  88         self.ovs_properties = attrs.get('ovs_properties', {})
  89         # add optional static network definition
  90         self.networks = attrs.get("networks", {})
  91
  92         LOG.debug("Nodes: %r", self.nodes)
  93         LOG.debug("NFVi Node: %r", self.nfvi_host)
  94         LOG.debug("Networks: %r", self.networks)
  95
  96     def setup_ovs(self):
  97         vpath = self.ovs_properties.get("vpath", "/usr/local")
  98         xargs_kill_cmd = self.PKILL_TEMPLATE % ('-9', 'ovs')
  99
 100         create_from = os.path.join(vpath, 'etc/openvswitch/conf.db')
 101         create_to = os.path.join(vpath, 'share/openvswitch/vswitch.ovsschema')
 102
 103         cmd_list = [
 104             "chmod 0666 /dev/vfio/*",
 105             "chmod a+x /dev/vfio",
 106             "pkill -9 ovs",
 107             xargs_kill_cmd,
 108             "killall -r 'ovs*'",
 109             "mkdir -p {0}/etc/openvswitch".format(vpath),
 110             "mkdir -p {0}/var/run/openvswitch".format(vpath),
 111             "rm {0}/etc/openvswitch/conf.db".format(vpath),
 112             "ovsdb-tool create {0} {1}".format(create_from, create_to),
 113             "modprobe vfio-pci",
 114             "chmod a+x /dev/vfio",
 115             "chmod 0666 /dev/vfio/*",
 116         ]
 117         for cmd in cmd_list:
 118             self.connection.execute(cmd)
 119         bind_cmd = "{dpdk_nic_bind} --force -b {driver} {port}"
 120         phy_driver = "vfio-pci"
 121         for key, port in self.networks.items():
 122             vpci = port.get("phy_port")
 123             self.connection.execute(bind_cmd.format(dpdk_nic_bind=self.dpdk_nic_bind,
 124                                                     driver=phy_driver, port=vpci))
 125
 126     def start_ovs_serverswitch(self):
 127         vpath = self.ovs_properties.get("vpath")
 128         pmd_nums = int(self.ovs_properties.get("pmd_threads", 2))
 129         ovs_sock_path = '/var/run/openvswitch/db.sock'
 130         log_path = '/var/log/openvswitch/ovs-vswitchd.log'
 131
 132         pmd_mask = hex(sum(2 ** num for num in range(pmd_nums)) << 1)
 133         socket0 = self.ovs_properties.get("ram", {}).get("socket_0", "2048")
 134         socket1 = self.ovs_properties.get("ram", {}).get("socket_1", "2048")
 135
 136         ovs_other_config = "ovs-vsctl {0}set Open_vSwitch . other_config:{1}"
 137         detach_cmd = "ovs-vswitchd unix:{0}{1} --pidfile --detach --log-file={2}"
 138
 139         cmd_list = [
 140             "mkdir -p /usr/local/var/run/openvswitch",
 141             "ovsdb-server --remote=punix:/{0}/{1}  --pidfile --detach".format(vpath,
 142                                                                               ovs_sock_path),
 143             ovs_other_config.format("--no-wait ", "dpdk-init=true"),
 144             ovs_other_config.format("--no-wait ", "dpdk-socket-mem='%s,%s'" % (socket0, socket1)),
 145             detach_cmd.format(vpath, ovs_sock_path, log_path),
 146             ovs_other_config.format("", "pmd-cpu-mask=%s" % pmd_mask),
 147         ]
 148
 149         for cmd in cmd_list:
 150             LOG.info(cmd)
 151             self.connection.execute(cmd)
 152         time.sleep(self.wait_for_vswitchd)
 153
 154     def setup_ovs_bridge_add_flows(self):
 155         dpdk_args = ""
 156         dpdk_list = []
 157         vpath = self.ovs_properties.get("vpath", "/usr/local")
 158         version = self.ovs_properties.get('version', {})
 159         ovs_ver = [int(x) for x in version.get('ovs', self.DEFAULT_OVS).split('.')]
 160         ovs_add_port = \
 161             "ovs-vsctl add-port {br} {port} -- set Interface {port} type={type_}{dpdk_args}"
 162         ovs_add_queue = "ovs-vsctl set Interface {port} options:n_rxq={queue}"
 163         chmod_vpath = "chmod 0777 {0}/var/run/openvswitch/dpdkvhostuser*"
 164
 165         cmd_dpdk_list = [
 166             "ovs-vsctl del-br br0",
 167             "rm -rf /usr/local/var/run/openvswitch/dpdkvhostuser*",
 168             "ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev",
 169         ]
 170
 171         ordered_network = OrderedDict(self.networks)
 172         for index, (key, vnf) in enumerate(ordered_network.items()):
 173             if ovs_ver >= [2, 7, 0]:
 174                 dpdk_args = " options:dpdk-devargs=%s" % vnf.get("phy_port")
 175             dpdk_list.append(ovs_add_port.format(br='br0', port='dpdk%s' % vnf.get("port_num", 0),
 176                                                  type_='dpdk', dpdk_args=dpdk_args))
 177             dpdk_list.append(ovs_add_queue.format(port='dpdk%s' % vnf.get("port_num", 0),
 178                                                   queue=self.ovs_properties.get("queues", 4)))
 179
 180         # Sorting the array to make sure we execute dpdk0... in the order
 181         list.sort(dpdk_list)
 182         cmd_dpdk_list.extend(dpdk_list)
 183
 184         # Need to do two for loop to maintain the dpdk/vhost ports.
 185         for index, _ in enumerate(ordered_network):
 186             cmd_dpdk_list.append(ovs_add_port.format(br='br0', port='dpdkvhostuser%s' % index,
 187                                                      type_='dpdkvhostuser', dpdk_args=""))
 188
 189         for cmd in cmd_dpdk_list:
 190             LOG.info(cmd)
 191             self.connection.execute(cmd)
 192
 193         # Fixme: add flows code
 194         ovs_flow = "ovs-ofctl add-flow br0 in_port=%s,action=output:%s"
 195
 196         network_count = len(ordered_network) + 1
 197         for in_port, out_port in zip(range(1, network_count),
 198                                      range(network_count, network_count * 2)):
 199             self.connection.execute(ovs_flow % (in_port, out_port))
 200             self.connection.execute(ovs_flow % (out_port, in_port))
 201
 202         self.connection.execute(chmod_vpath.format(vpath))
 203
 204     def cleanup_ovs_dpdk_env(self):
 205         self.connection.execute("ovs-vsctl del-br br0")
 206         self.connection.execute("pkill -9 ovs")
 207
 208     def check_ovs_dpdk_env(self):
 209         self.cleanup_ovs_dpdk_env()
 210
 211         version = self.ovs_properties.get("version", {})
 212         ovs_ver = version.get("ovs", self.DEFAULT_OVS)
 213         dpdk_ver = version.get("dpdk", "16.07.2").split('.')
 214
 215         supported_version = self.SUPPORTED_OVS_TO_DPDK_MAP.get(ovs_ver, None)
 216         if supported_version is None or supported_version.split('.')[:2] != dpdk_ver[:2]:
 217             raise Exception("Unsupported ovs '{}'. Please check the config...".format(ovs_ver))
 218
 219         status = self.connection.execute("ovs-vsctl -V | grep -i '%s'" % ovs_ver)[0]
 220         if status:
 221             deploy = OvsDeploy(self.connection,
 222                                get_nsb_option("bin_path"),
 223                                self.ovs_properties)
 224             deploy.ovs_deploy()
 225
 226     def deploy(self):
 227         """don't need to deploy"""
 228
 229         # Todo: NFVi deploy (sriov, vswitch, ovs etc) based on the config.
 230         if not self.vm_deploy:
 231             return
 232
 233         self.connection = ssh.SSH.from_node(self.host_mgmt)
 234         self.dpdk_nic_bind = provision_tool(
 235             self.connection,
 236             os.path.join(get_nsb_option("bin_path"), "dpdk-devbind.py"))
 237
 238         # Check dpdk/ovs version, if not present install
 239         self.check_ovs_dpdk_env()
 240         #    Todo: NFVi deploy (sriov, vswitch, ovs etc) based on the config.
 241         StandaloneContextHelper.install_req_libs(self.connection)
 242         self.networks = StandaloneContextHelper.get_nic_details(self.connection,
 243                                                                 self.networks,
 244                                                                 self.dpdk_nic_bind)
 245
 246         self.setup_ovs()
 247         self.start_ovs_serverswitch()
 248         self.setup_ovs_bridge_add_flows()
 249         self.nodes = self.setup_ovs_dpdk_context()
 250         LOG.debug("Waiting for VM to come up...")
 251         self.nodes = StandaloneContextHelper.wait_for_vnfs_to_start(self.connection,
 252                                                                     self.servers,
 253                                                                     self.nodes)
 254
 255     def undeploy(self):
 256
 257         if not self.vm_deploy:
 258             return
 259
 260         # Cleanup the ovs installation...
 261         self.cleanup_ovs_dpdk_env()
 262
 263         # Bind nics back to kernel
 264         bind_cmd = "{dpdk_nic_bind} --force -b {driver} {port}"
 265         for key, port in self.networks.items():
 266             vpci = port.get("phy_port")
 267             phy_driver = port.get("driver")
 268             self.connection.execute(bind_cmd.format(dpdk_nic_bind=self.dpdk_nic_bind,
 269                                                     driver=phy_driver, port=vpci))
 270
 271         # Todo: NFVi undeploy (sriov, vswitch, ovs etc) based on the config.
 272         for vm in self.vm_names:
 273             Libvirt.check_if_vm_exists_and_delete(vm, self.connection)
 274
 275     def _get_server(self, attr_name):
 276         """lookup server info by name from context
 277
 278         Keyword arguments:
 279         attr_name -- A name for a server listed in nodes config file
 280         """
 281         node_name, name = self.split_name(attr_name)
 282         if name is None or self.name != name:
 283             return None
 284
 285         matching_nodes = (n for n in self.nodes if n["name"] == node_name)
 286         try:
 287             # A clone is created in order to avoid affecting the
 288             # original one.
 289             node = dict(next(matching_nodes))
 290         except StopIteration:
 291             return None
 292
 293         try:
 294             duplicate = next(matching_nodes)
 295         except StopIteration:
 296             pass
 297         else:
 298             raise ValueError("Duplicate nodes!!! Nodes: %s %s",
 299                              (node, duplicate))
 300
 301         node["name"] = attr_name
 302         return node
 303
 304     def _get_network(self, attr_name):
 305         if not isinstance(attr_name, collections.Mapping):
 306             network = self.networks.get(attr_name)
 307
 308         else:
 309             # Don't generalize too much  Just support vld_id
 310             vld_id = attr_name.get('vld_id', {})
 311             # for standalone context networks are dicts
 312             iter1 = (n for n in self.networks.values() if n.get('vld_id') == vld_id)
 313             network = next(iter1, None)
 314
 315         if network is None:
 316             return None
 317
 318         result = {
 319             # name is required
 320             "name": network["name"],
 321             "vld_id": network.get("vld_id"),
 322             "segmentation_id": network.get("segmentation_id"),
 323             "network_type": network.get("network_type"),
 324             "physical_network": network.get("physical_network"),
 325         }
 326         return result
 327
 328     def configure_nics_for_ovs_dpdk(self):
 329         portlist = OrderedDict(self.networks)
 330         for key, ports in portlist.items():
 331             mac = StandaloneContextHelper.get_mac_address()
 332             portlist[key].update({'mac': mac})
 333         self.networks = portlist
 334         LOG.info("Ports %s" % self.networks)
 335
 336     def _enable_interfaces(self, index, vfs, cfg):
 337         vpath = self.ovs_properties.get("vpath", "/usr/local")
 338         vf = self.networks[vfs[0]]
 339         port_num = vf.get('port_num', 0)
 340         vpci = PciAddress.parse_address(vf['vpci'].strip(), multi_line=True)
 341         # Generate the vpci for the interfaces
 342         slot = index + port_num + 10
 343         vf['vpci'] = \
 344             "{}:{}:{:02x}.{}".format(vpci.domain, vpci.bus, slot, vpci.function)
 345         Libvirt.add_ovs_interface(vpath, port_num, vf['vpci'], vf['mac'], str(cfg))
 346
 347     def setup_ovs_dpdk_context(self):
 348         nodes = []
 349
 350         self.configure_nics_for_ovs_dpdk()
 351
 352         for index, (key, vnf) in enumerate(OrderedDict(self.servers).items()):
 353             cfg = '/tmp/vm_ovs_%d.xml' % index
 354             vm_name = "vm_%d" % index
 355
 356             # 1. Check and delete VM if already exists
 357             Libvirt.check_if_vm_exists_and_delete(vm_name, self.connection)
 358
 359             vcpu, mac = Libvirt.build_vm_xml(self.connection, self.vm_flavor, cfg, vm_name, index)
 360             # 2: Cleanup already available VMs
 361             for idx, (vkey, vfs) in enumerate(OrderedDict(vnf["network_ports"]).items()):
 362                 if vkey == "mgmt":
 363                     continue
 364                 self._enable_interfaces(index, vfs, cfg)
 365
 366             # copy xml to target...
 367             self.connection.put(cfg, cfg)
 368
 369             #    FIXME: launch through libvirt
 370             LOG.info("virsh create ...")
 371             Libvirt.virsh_create_vm(self.connection, cfg)
 372
 373             #    5: Tunning for better performace
 374             Libvirt.pin_vcpu_for_perf(self.connection, vm_name, vcpu)
 375             self.vm_names.append(vm_name)
 376
 377             # build vnf node details
 378             nodes.append(self.vnf_node.generate_vnf_instance(self.vm_flavor,
 379                                                              self.networks,
 380                                                              self.host_mgmt.get('ip'),
 381                                                              key, vnf, mac))
 382
 383         return nodes