NFVBENCH-189: Add a fix to work around the i40e_VF port initialization issue
[nfvbench.git] / nfvbench / traffic_server.py
1 # Copyright 2016 Cisco Systems, Inc.  All rights reserved.
2 #
3 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
4 #    not use this file except in compliance with the License. You may obtain
5 #    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, WITHOUT
11 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 #    License for the specific language governing permissions and limitations
13 #    under the License.
14
15 import os
16 import subprocess
17 import yaml
18
19 from .log import LOG
20
21
22 class TrafficServerException(Exception):
23     pass
24
25 class TrafficServer(object):
26     """Base class for traffic servers."""
27
28 class TRexTrafficServer(TrafficServer):
29     """Creates configuration file for TRex and runs server."""
30
31     def __init__(self, trex_base_dir='/opt/trex'):
32         contents = os.listdir(trex_base_dir)
33         # only one version of TRex should be supported in container
34         assert len(contents) == 1
35         self.trex_dir = os.path.join(trex_base_dir, contents[0])
36
37     def run_server(self, generator_config, filename='/etc/trex_cfg.yaml'):
38         """Run TRex server for specified traffic profile.
39
40         :param traffic_profile: traffic profile object based on config file
41         :param filename: path where to save TRex config file
42         """
43         cfg = self.__save_config(generator_config, filename)
44         cores = generator_config.cores
45         vtep_vlan = generator_config.gen_config.get('vtep_vlan')
46         sw_mode = "--software" if generator_config.software_mode else ""
47         vlan_opt = "--vlan" if (generator_config.vlan_tagging or vtep_vlan) else ""
48         if generator_config.mbuf_factor:
49             mbuf_opt = "--mbuf-factor " + str(generator_config.mbuf_factor)
50         else:
51             mbuf_opt = ""
52         hdrh_opt = "--hdrh" if generator_config.hdrh else ""
53         # --unbind-unused-ports: for NIC that have more than 2 ports such as Intel X710
54         # this will instruct trex to unbind all ports that are unused instead of
55         # erroring out with an exception (i40e only)
56         cmd = ['nohup', '/bin/bash', '-c',
57                './t-rex-64 -i -c {} --iom 0 --no-scapy-server '
58                '--unbind-unused-ports --close-at-end {} {} '
59                '{} {} --cfg {} &> /tmp/trex.log & disown'.format(cores, sw_mode,
60                                                                  vlan_opt,
61                                                                  hdrh_opt,
62                                                                  mbuf_opt, cfg)]
63         LOG.info(' '.join(cmd))
64         subprocess.Popen(cmd, cwd=self.trex_dir)
65         LOG.info('TRex server is running...')
66
67     def __load_config(self, filename):
68         result = {}
69         if os.path.exists(filename):
70             with open(filename, 'r') as stream:
71                 try:
72                     result = yaml.safe_load(stream)
73                 except yaml.YAMLError as exc:
74                     print(exc)
75         return result
76
77     def __save_config(self, generator_config, filename):
78         result = self.__prepare_config(generator_config)
79         yaml.safe_load(result)
80         if os.path.exists(filename):
81             os.remove(filename)
82         with open(filename, 'w') as f:
83             f.write(result)
84         return filename
85
86     def __prepare_config(self, generator_config):
87         ifs = ",".join([repr(pci) for pci in generator_config.pcis])
88
89         # For consistency and stability reasons, the T-Rex server
90         # should be forciby restarted each time the value of a
91         # parameter, specified as one of the starting command line
92         # arguments, has been modified since the last launch.
93         # Hence we add some extra fields to the config file (nb_cores,
94         # use_vlan) which will serve as a memory between runs -
95         # while being actually ignored by the T-Rex server.
96
97         result = """# Config generated by NFVbench
98         - port_limit : 2
99           version    : 2
100           zmq_pub_port : {zmq_pub_port}
101           zmq_rpc_port : {zmq_rpc_port}
102           prefix       : {prefix}
103           limit_memory : {limit_memory}
104           nb_cores : {nb_cores}
105           use_vlan : {use_vlan}
106           interfaces : [{ifs}]""".format(zmq_pub_port=generator_config.zmq_pub_port,
107                                          zmq_rpc_port=generator_config.zmq_rpc_port,
108                                          prefix=generator_config.name,
109                                          limit_memory=generator_config.limit_memory,
110                                          nb_cores=generator_config.cores,
111                                          use_vlan=generator_config.gen_config.get('vtep_vlan')
112                                          or generator_config.vlan_tagging,
113                                          ifs=ifs)
114
115         if hasattr(generator_config, 'mbuf_64') and generator_config.mbuf_64:
116             result += """
117           memory       :
118             mbuf_64           : {mbuf_64}""".format(mbuf_64=generator_config.mbuf_64)
119
120         if self.__check_platform_config(generator_config):
121             try:
122                 platform = """
123           platform     :
124             master_thread_id  : {master_thread_id}
125             latency_thread_id : {latency_thread_id}
126             dual_if:""".format(master_thread_id=generator_config.gen_config.platform.
127                                master_thread_id,
128                                latency_thread_id=generator_config.gen_config.platform.
129                                latency_thread_id)
130                 result += platform
131
132                 for core in generator_config.gen_config.platform.dual_if:
133                     threads = ""
134                     try:
135                         threads = ",".join([repr(thread) for thread in core.threads])
136                     except TypeError:
137                         LOG.warning("No threads defined for socket %s", core.socket)
138                     core_result = """
139                   - socket : {socket}
140                     threads : [{threads}]""".format(socket=core.socket, threads=threads)
141                     result += core_result
142             except (KeyError, AttributeError):
143                 pass
144         return result + "\n"
145
146     def __check_platform_config(self, generator_config):
147         return hasattr(generator_config.gen_config, 'platform') \
148             and hasattr(generator_config.gen_config.platform, "master_thread_id") \
149             and generator_config.gen_config.platform.master_thread_id is not None \
150             and hasattr(generator_config.gen_config.platform, "latency_thread_id") \
151             and generator_config.gen_config.platform.latency_thread_id is not None
152
153     def check_config_updated(self, generator_config):
154         existing_config = self.__load_config(filename='/etc/trex_cfg.yaml')
155         new_config = yaml.safe_load(self.__prepare_config(generator_config))
156         LOG.debug("Existing config: %s", existing_config)
157         LOG.debug("New config: %s", new_config)
158         if existing_config == new_config:
159             return False
160         return True