1 # Copyright 2016 Cisco Systems, Inc. All rights reserved.
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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
22 class TrafficServerException(Exception):
25 class TrafficServer(object):
26 """Base class for traffic servers."""
28 class TRexTrafficServer(TrafficServer):
29 """Creates configuration file for TRex and runs server."""
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])
37 def run_server(self, generator_config, filename='/etc/trex_cfg.yaml'):
38 """Run TRex server for specified traffic profile.
40 :param traffic_profile: traffic profile object based on config file
41 :param filename: path where to save TRex config file
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)
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,
63 LOG.info(' '.join(cmd))
64 subprocess.Popen(cmd, cwd=self.trex_dir)
65 LOG.info('TRex server is running...')
67 def __load_config(self, filename):
69 if os.path.exists(filename):
70 with open(filename, 'r') as stream:
72 result = yaml.safe_load(stream)
73 except yaml.YAMLError as exc:
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):
82 with open(filename, 'w') as f:
86 def __prepare_config(self, generator_config):
87 ifs = ",".join([repr(pci) for pci in generator_config.pcis])
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.
97 result = """# Config generated by NFVbench
100 zmq_pub_port : {zmq_pub_port}
101 zmq_rpc_port : {zmq_rpc_port}
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,
115 if hasattr(generator_config, 'mbuf_64') and generator_config.mbuf_64:
118 mbuf_64 : {mbuf_64}""".format(mbuf_64=generator_config.mbuf_64)
120 if self.__check_platform_config(generator_config):
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.
128 latency_thread_id=generator_config.gen_config.platform.
132 for core in generator_config.gen_config.platform.dual_if:
135 threads = ",".join([repr(thread) for thread in core.threads])
137 LOG.warning("No threads defined for socket %s", core.socket)
140 threads : [{threads}]""".format(socket=core.socket, threads=threads)
141 result += core_result
142 except (KeyError, AttributeError):
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
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: