d46a27d960d3320c2759a0b59c99ffa65019a32c
[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 __load_config(self, filename):
61         result = {}
62         if os.path.exists(filename):
63             with open(filename, 'r') as stream:
64                 try:
65                     result = yaml.load(stream)
66                 except yaml.YAMLError as exc:
67                     print exc
68         return result
69
70     def __save_config(self, generator_config, filename):
71         result = self.__prepare_config(generator_config)
72         yaml.safe_load(result)
73         if os.path.exists(filename):
74             os.remove(filename)
75         with open(filename, 'w') as f:
76             f.write(result)
77         return filename
78
79     def __prepare_config(self, generator_config):
80         ifs = ",".join([repr(pci) for pci in generator_config.pcis])
81         result = """# Config generated by NFVbench
82         - port_limit : 2
83           version    : 2
84           zmq_pub_port : {zmq_pub_port}
85           zmq_rpc_port : {zmq_rpc_port}
86           prefix       : {prefix}
87           limit_memory : {limit_memory}
88           interfaces : [{ifs}]""".format(zmq_pub_port=generator_config.zmq_pub_port,
89                                          zmq_rpc_port=generator_config.zmq_rpc_port,
90                                          prefix=generator_config.name,
91                                          limit_memory=generator_config.limit_memory,
92                                          ifs=ifs)
93         if hasattr(generator_config, 'platform'):
94             if generator_config.platform.master_thread_id \
95                     and generator_config.platform.latency_thread_id:
96                 platform = """
97           platform     :
98             master_thread_id  : {master_thread_id}
99             latency_thread_id : {latency_thread_id}
100             dual_if:""".format(master_thread_id=generator_config.platform.master_thread_id,
101                                latency_thread_id=generator_config.platform.latency_thread_id)
102                 result += platform
103
104                 for core in generator_config.platform.dual_if:
105                     threads = ""
106                     try:
107                         threads = ",".join([repr(thread) for thread in core.threads])
108                     except TypeError:
109                         LOG.warn("No threads defined for socket %s", core.socket)
110                     core_result = """
111                   - socket : {socket}
112                     threads : [{threads}]""".format(socket=core.socket, threads=threads)
113                     result += core_result
114             else:
115                 LOG.info("Generator profile 'platform' sub-properties are set but not filled in \
116                          config file. TRex will use default values.")
117         return result
118
119     def check_config_updated(self, generator_config):
120         existing_config = self.__load_config(filename='/etc/trex_cfg.yaml')
121         new_config = yaml.safe_load(self.__prepare_config(generator_config))
122         LOG.debug("Existing config: %s", existing_config)
123         LOG.debug("New config: %s", new_config)
124         if existing_config == new_config:
125             return False
126         return True