yardstick/network_services/vnf_generic/vnf/tg_trex.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 """ Trex acts as traffic generation and vnf definitions based on IETS Spec """
  15
  16 from __future__ import absolute_import
  17 from __future__ import print_function
  18
  19 import logging
  20 import os
  21
  22 import yaml
  23
  24 from yardstick.common.utils import mac_address_to_hex_list
  25 from yardstick.network_services.utils import get_nsb_option
  26 from yardstick.network_services.vnf_generic.vnf.sample_vnf import SampleVNFTrafficGen
  27 from yardstick.network_services.vnf_generic.vnf.sample_vnf import ClientResourceHelper
  28 from yardstick.network_services.vnf_generic.vnf.sample_vnf import DpdkVnfSetupEnvHelper
  29
  30 LOG = logging.getLogger(__name__)
  31
  32
  33 class TrexDpdkVnfSetupEnvHelper(DpdkVnfSetupEnvHelper):
  34     APP_NAME = "t-rex-64"
  35     CFG_CONFIG = ""
  36     CFG_SCRIPT = ""
  37     PIPELINE_COMMAND = ""
  38     VNF_TYPE = "TG"
  39
  40
  41 class TrexResourceHelper(ClientResourceHelper):
  42
  43     CONF_FILE = '/tmp/trex_cfg.yaml'
  44     QUEUE_WAIT_TIME = 1
  45     RESOURCE_WORD = 'trex'
  46     RUN_DURATION = 0
  47
  48     ASYNC_PORT = 4500
  49     SYNC_PORT = 4501
  50
  51     def generate_cfg(self):
  52         ext_intf = self.vnfd_helper.interfaces
  53         vpci_list = []
  54         port_list = []
  55         trex_cfg = {
  56             'interfaces': vpci_list,
  57             'port_info': port_list,
  58             "port_limit": len(ext_intf),
  59             "version": '2',
  60         }
  61         cfg_file = [trex_cfg]
  62
  63         for interface in ext_intf:
  64             virtual_interface = interface['virtual-interface']
  65             vpci_list.append(virtual_interface["vpci"])
  66             dst_mac = virtual_interface["dst_mac"]
  67
  68             if not dst_mac:
  69                 continue
  70
  71             local_mac = virtual_interface["local_mac"]
  72             port_list.append({
  73                 "src_mac": mac_address_to_hex_list(local_mac),
  74                 "dest_mac": mac_address_to_hex_list(dst_mac),
  75             })
  76
  77         cfg_str = yaml.safe_dump(cfg_file, default_flow_style=False, explicit_start=True)
  78         self.ssh_helper.upload_config_file(os.path.basename(self.CONF_FILE), cfg_str)
  79         self._vpci_ascending = sorted(vpci_list)
  80
  81     def check_status(self):
  82         status, _, _ = self.ssh_helper.execute("sudo lsof -i:%s" % self.SYNC_PORT)
  83         return status
  84
  85     # temp disable
  86     DISABLE_DEPLOY = True
  87
  88     def setup(self):
  89         super(TrexResourceHelper, self).setup()
  90         if self.DISABLE_DEPLOY:
  91             return
  92
  93         trex_path = self.ssh_helper.join_bin_path('trex')
  94
  95         err = self.ssh_helper.execute("which {}".format(trex_path))[0]
  96         if err == 0:
  97             return
  98
  99         LOG.info("Copying %s to destination...", self.RESOURCE_WORD)
 100         self.ssh_helper.run("sudo mkdir -p '{}'".format(os.path.dirname(trex_path)))
 101         self.ssh_helper.put("~/.bash_profile", "~/.bash_profile")
 102         self.ssh_helper.put(trex_path, trex_path, True)
 103         ko_src = os.path.join(trex_path, "scripts/ko/src/")
 104         self.ssh_helper.execute(self.MAKE_INSTALL.format(ko_src))
 105
 106     def start(self, ports=None, *args, **kwargs):
 107         cmd = "sudo fuser -n tcp {0.SYNC_PORT} {0.ASYNC_PORT} -k > /dev/null 2>&1"
 108         self.ssh_helper.execute(cmd.format(self))
 109
 110         self.ssh_helper.execute("sudo pkill -9 rex > /dev/null 2>&1")
 111
 112         trex_path = self.ssh_helper.join_bin_path("trex", "scripts")
 113         path = get_nsb_option("trex_path", trex_path)
 114
 115         # cmd = "sudo ./t-rex-64 -i --cfg %s > /dev/null 2>&1" % self.CONF_FILE
 116         cmd = "./t-rex-64 -i --cfg '{}'".format(self.CONF_FILE)
 117
 118         # if there are errors we want to see them
 119         # we have to sudo cd because the path might be owned by root
 120         trex_cmd = """sudo bash -c "cd '{}' ; {}" >/dev/null""".format(path, cmd)
 121         self.ssh_helper.execute(trex_cmd)
 122
 123     def terminate(self):
 124         super(TrexResourceHelper, self).terminate()
 125         cmd = "sudo fuser -n tcp %s %s -k > /dev/null 2>&1"
 126         self.ssh_helper.execute(cmd % (self.SYNC_PORT, self.ASYNC_PORT))
 127
 128
 129 class TrexTrafficGen(SampleVNFTrafficGen):
 130     """
 131     This class handles mapping traffic profile and generating
 132     traffic for given testcase
 133     """
 134
 135     APP_NAME = 'TRex'
 136
 137     def __init__(self, name, vnfd, setup_env_helper_type=None, resource_helper_type=None):
 138         if resource_helper_type is None:
 139             resource_helper_type = TrexResourceHelper
 140
 141         if setup_env_helper_type is None:
 142             setup_env_helper_type = TrexDpdkVnfSetupEnvHelper
 143
 144         super(TrexTrafficGen, self).__init__(name, vnfd, setup_env_helper_type,
 145                                              resource_helper_type)
 146
 147     def _check_status(self):
 148         return self.resource_helper.check_status()
 149
 150     def _start_server(self):
 151         super(TrexTrafficGen, self)._start_server()
 152         self.resource_helper.start()
 153
 154     def scale(self, flavor=""):
 155         pass
 156
 157     def listen_traffic(self, traffic_profile):
 158         pass
 159
 160     def terminate(self):
 161         self.resource_helper.terminate()