NFVBENCH-121 Add TRex parameters to tune performance and allocate ressources
[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         subprocess.Popen(['nohup', '/bin/bash', '-c',
53                           './t-rex-64 -i -c {} --iom 0 --no-scapy-server --close-at-end {} '
54                           '{} {} --cfg {} &> /tmp/trex.log & disown'.format(cores, sw_mode,
55                                                                             vlan_opt,
56                                                                             mbuf_opt, cfg)],
57                          cwd=self.trex_dir)
58         LOG.info('TRex server is running...')
59
60     def __save_config(self, generator_config, filename):
61         ifs = ",".join([repr(pci) for pci in generator_config.pcis])
62
63         result = """# Config generated by NFVbench
64         - port_limit : 2
65           version    : 2
66           zmq_pub_port : {zmq_pub_port}
67           zmq_rpc_port : {zmq_rpc_port}
68           prefix       : {prefix}
69           limit_memory : {limit_memory}
70           interfaces : [{ifs}]""".format(zmq_pub_port=generator_config.zmq_pub_port,
71                                          zmq_rpc_port=generator_config.zmq_rpc_port,
72                                          prefix=generator_config.name,
73                                          limit_memory=generator_config.limit_memory,
74                                          ifs=ifs)
75         if hasattr(generator_config, 'platform'):
76             if generator_config.platform.master_thread_id \
77                     and generator_config.platform.latency_thread_id:
78                 platform = """
79           platform     :
80             master_thread_id  : {master_thread_id}
81             latency_thread_id : {latency_thread_id}
82             dual_if:""".format(master_thread_id=generator_config.platform.master_thread_id,
83                                latency_thread_id=generator_config.platform.latency_thread_id)
84                 result += platform
85
86                 for core in generator_config.platform.dual_if:
87                     threads = ""
88                     try:
89                         threads = ",".join([repr(thread) for thread in core.threads])
90                     except TypeError:
91                         LOG.warn("No threads defined for socket %s", core.socket)
92                     core_result = """
93                   - socket : {socket}
94                     threads : [{threads}]""".format(socket=core.socket, threads=threads)
95                     result += core_result
96             else:
97                 LOG.info("Generator profile 'platform' sub-properties are set but not filled in \
98                          config file. TRex will use default values.")
99
100         yaml.safe_load(result)
101         if os.path.exists(filename):
102             os.remove(filename)
103         with open(filename, 'w') as f:
104             f.write(result)
105
106         return filename