1 # Copyright (c) 2016 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Performance testing traffic generator library."""
16 from robot.api import logger
17 from robot.libraries.BuiltIn import BuiltIn
19 from resources.libraries.python.constants import Constants
20 from resources.libraries.python.ssh import SSH
21 from resources.libraries.python.topology import NodeType
22 from resources.libraries.python.topology import NodeSubTypeTG
23 from resources.libraries.python.topology import Topology
24 from resources.libraries.python.DropRateSearch import DropRateSearch
26 __all__ = ['TrafficGenerator', 'TGDropRateSearchImpl']
29 class TGDropRateSearchImpl(DropRateSearch):
30 """Drop Rate Search implementation."""
33 super(TGDropRateSearchImpl, self).__init__()
35 def measure_loss(self, rate, frame_size, loss_acceptance,
36 loss_acceptance_type, traffic_type):
37 """Runs the traffic and evaluate the measured results.
39 :param rate: Offered traffic load.
40 :param frame_size: Size of frame.
41 :param loss_acceptance: Permitted drop ratio or frames count.
42 :param loss_acceptance_type: Type of permitted loss.
43 :param traffic_type: Traffic profile ([2,3]-node-L[2,3], ...).
46 :type loss_acceptance: float
47 :type loss_acceptance_type: LossAcceptanceType
48 :type traffic_type: str
49 :returns: Drop threshold exceeded? (True/False)
51 :raises: NotImplementedError if TG is not supported.
52 :raises: RuntimeError if TG is not specified.
54 # we need instance of TrafficGenerator instantiated by Robot Framework
55 # to be able to use trex_stl-*()
56 tg_instance = BuiltIn().get_library_instance(
57 'resources.libraries.python.TrafficGenerator')
59 if tg_instance.node['subtype'] is None:
60 raise RuntimeError('TG subtype not defined')
61 elif tg_instance.node['subtype'] == NodeSubTypeTG.TREX:
62 unit_rate = str(rate) + self.get_rate_type_str()
63 tg_instance.trex_stl_start_remote_exec(self.get_duration(),
64 unit_rate, frame_size,
66 loss = tg_instance.get_loss()
67 sent = tg_instance.get_sent()
68 if self.loss_acceptance_type_is_percentage():
69 loss = (float(loss) / float(sent)) * 100
71 logger.trace("comparing: {} < {} {}".format(loss,
73 loss_acceptance_type))
74 if float(loss) > float(loss_acceptance):
79 raise NotImplementedError("TG subtype not supported")
81 def get_latency(self):
82 """Returns min/avg/max latency.
84 :returns: Latency stats.
87 tg_instance = BuiltIn().get_library_instance(
88 'resources.libraries.python.TrafficGenerator')
89 return tg_instance.get_latency_int()
92 class TrafficGenerator(object):
93 """Traffic Generator."""
95 # use one instance of TrafficGenerator for all tests in test suite
96 ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
103 self._received = None
105 # T-REX interface order mapping
106 self._ifaces_reordered = False
112 :returns: Traffic generator node.
118 """Return number of lost packets.
120 :returns: Number of lost packets.
126 """Return number of sent packets.
128 :returns: Number of sent packets.
133 def get_received(self):
134 """Return number of received packets.
136 :returns: Number of received packets.
139 return self._received
141 def get_latency_int(self):
142 """Return rounded min/avg/max latency.
144 :returns: Latency stats.
149 def initialize_traffic_generator(self, tg_node, tg_if1, tg_if2,
150 tg_if1_adj_node, tg_if1_adj_if,
151 tg_if2_adj_node, tg_if2_adj_if,
153 tg_if1_dst_mac=None, tg_if2_dst_mac=None):
154 """TG initialization.
156 :param tg_node: Traffic generator node.
157 :param tg_if1: TG - name of first interface.
158 :param tg_if2: TG - name of second interface.
159 :param tg_if1_adj_node: TG if1 adjecent node.
160 :param tg_if1_adj_if: TG if1 adjecent interface.
161 :param tg_if2_adj_node: TG if2 adjecent node.
162 :param tg_if2_adj_if: TG if2 adjecent interface.
163 :param test_type: 'L2' or 'L3' - src/dst MAC address.
164 :param tg_if1_dst_mac: Interface 1 destination MAC address.
165 :param tg_if2_dst_mac: Interface 2 destination MAC address.
169 :type tg_if1_adj_node: dict
170 :type tg_if1_adj_if: str
171 :type tg_if2_adj_node: dict
172 :type tg_if2_adj_if: str
174 :type tg_if1_dst_mac: str
175 :type tg_if2_dst_mac: str
177 :raises: RuntimeError in case of issue during initialization.
182 if tg_node['type'] != NodeType.TG:
183 raise RuntimeError('Node type is not a TG')
186 if tg_node['subtype'] == NodeSubTypeTG.TREX:
187 trex_path = "/opt/trex-core-2.29"
192 (ret, stdout, stderr) = ssh.exec_command(
193 "sudo -E sh -c '{}/resources/tools/trex/"
194 "trex_installer.sh'".format(Constants.REMOTE_FW_DIR),
197 logger.error('TRex installation failed: {0}'.format(
199 raise RuntimeError('Installation of TG failed')
201 if1_pci = topo.get_interface_pci_addr(tg_node, tg_if1)
202 if2_pci = topo.get_interface_pci_addr(tg_node, tg_if2)
203 if1_mac = topo.get_interface_mac(tg_node, tg_if1)
204 if2_mac = topo.get_interface_mac(tg_node, tg_if2)
206 if test_type == 'L2':
207 if1_adj_mac = if2_mac
208 if2_adj_mac = if1_mac
209 elif test_type == 'L3':
210 if1_adj_mac = topo.get_interface_mac(tg_if1_adj_node,
212 if2_adj_mac = topo.get_interface_mac(tg_if2_adj_node,
215 raise ValueError("test_type unknown")
217 if tg_if1_dst_mac is not None and tg_if2_dst_mac is not None:
218 if1_adj_mac = tg_if1_dst_mac
219 if2_adj_mac = tg_if2_dst_mac
221 if min(if1_pci, if2_pci) != if1_pci:
222 if1_mac, if2_mac = if2_mac, if1_mac
223 if1_pci, if2_pci = if2_pci, if1_pci
224 if1_adj_mac, if2_adj_mac = if2_adj_mac, if1_adj_mac
225 self._ifaces_reordered = True
227 if1_mac_hex = "0x"+if1_mac.replace(":", ",0x")
228 if2_mac_hex = "0x"+if2_mac.replace(":", ",0x")
229 if1_adj_mac_hex = "0x"+if1_adj_mac.replace(":", ",0x")
230 if2_adj_mac_hex = "0x"+if2_adj_mac.replace(":", ",0x")
232 (ret, stdout, stderr) = ssh.exec_command(
233 "sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
236 " interfaces : [\"{}\",\"{}\"]\n"
238 " - dest_mac : [{}]\n"
240 " - dest_mac : [{}]\n"
243 .format(if1_pci, if2_pci,
244 if1_adj_mac_hex, if1_mac_hex,
245 if2_adj_mac_hex, if2_mac_hex))
247 logger.error("failed to create t-rex config: {}"\
248 .format(stdout + stderr))
249 raise RuntimeError('trex config generation error')
251 max_startup_retries = 3
252 while max_startup_retries > 0:
253 # kill T-rex only if it is already running
254 (ret, _, _) = ssh.exec_command(
255 "sh -c 'pgrep t-rex && sudo pkill t-rex && sleep 3'")
258 (ret, stdout, stderr) = ssh.exec_command(
259 "sh -c 'cd {0}/scripts/ && sudo ./trex-cfg'"\
262 logger.error('trex-cfg failed: {0}'.format(stdout + stderr))
263 raise RuntimeError('trex-cfg failed')
266 (ret, _, _) = ssh.exec_command(
267 "sh -c 'cd {0}/scripts/ && "
268 "sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /dev/null 2>&1 &'"
272 raise RuntimeError('t-rex-64 startup failed')
274 # get T-rex server info
275 (ret, _, _) = ssh.exec_command(
277 "{0}/resources/tools/trex/trex_server_info.py'"\
278 .format(Constants.REMOTE_FW_DIR),
281 # If we get info T-rex is running
284 max_startup_retries -= 1
285 # after max retries T-rex is still not responding to API
286 # critical error occurred
287 raise RuntimeError('t-rex-64 startup failed')
290 def teardown_traffic_generator(node):
293 :param node: Traffic generator node.
296 :raises: RuntimeError if T-rex teardown failed.
297 :raises: RuntimeError if node type is not a TG.
299 if node['type'] != NodeType.TG:
300 raise RuntimeError('Node type is not a TG')
301 if node['subtype'] == NodeSubTypeTG.TREX:
304 (ret, stdout, stderr) = ssh.exec_command(
305 "sh -c 'sudo pkill t-rex && sleep 3'")
307 logger.error('pkill t-rex failed: {0}'.format(stdout + stderr))
308 raise RuntimeError('pkill t-rex failed')
311 def trex_stl_stop_remote_exec(node):
312 """Execute script on remote node over ssh to stop running traffic.
314 :param node: T-REX generator node.
317 :raises: RuntimeError if stop traffic script fails.
322 (ret, _, _) = ssh.exec_command(
323 "sh -c '{}/resources/tools/trex/"
324 "trex_stateless_stop.py'".format(Constants.REMOTE_FW_DIR))
327 raise RuntimeError('T-rex stateless runtime error')
329 def trex_stl_start_remote_exec(self, duration, rate, framesize,
330 traffic_type, async_call=False,
331 latency=True, warmup_time=5):
332 """Execute script on remote node over ssh to start traffic.
334 :param duration: Time expresed in seconds for how long to send traffic.
335 :param rate: Traffic rate expressed with units (pps, %)
336 :param framesize: L2 frame size to send (without padding and IPG).
337 :param traffic_type: Traffic profile.
338 :param async_call: If enabled then don't wait for all incomming trafic.
339 :param latency: With latency measurement.
340 :param warmup_time: Warmup time period.
344 :type traffic_type: str
345 :type async_call: bool
347 :type warmup_time: int
349 :raises: RuntimeError in case of TG driver issue.
352 ssh.connect(self._node)
354 _async = "--async" if async_call else ""
355 _latency = "--latency" if latency else ""
356 _p0, _p1 = (2, 1) if self._ifaces_reordered else (1, 2)
358 profile_path = ("{0}/resources/traffic_profiles/trex/"
359 "{1}.py".format(Constants.REMOTE_FW_DIR,
361 (ret, stdout, _) = ssh.exec_command(
363 "'{0}/resources/tools/trex/trex_stateless_profile.py "
373 format(Constants.REMOTE_FW_DIR, profile_path, duration, framesize,
374 rate, warmup_time, _p0 - 1, _p1 - 1, _async, _latency),
375 timeout=int(duration) + 60)
378 raise RuntimeError('T-rex stateless runtime error')
381 self._received = None
386 # last line from console output
387 line = stdout.splitlines()[-1]
390 logger.info('TrafficGen result: {0}'.format(self._result))
392 self._received = self._result.split(', ')[1].split('=')[1]
393 self._sent = self._result.split(', ')[2].split('=')[1]
394 self._loss = self._result.split(', ')[3].split('=')[1]
397 self._latency.append(self._result.split(', ')[4].split('=')[1])
398 self._latency.append(self._result.split(', ')[5].split('=')[1])
400 def stop_traffic_on_tg(self):
401 """Stop all traffic on TG.
404 :raises: RuntimeError if TG is not set.
406 if self._node is None:
407 raise RuntimeError("TG is not set")
408 if self._node['subtype'] == NodeSubTypeTG.TREX:
409 self.trex_stl_stop_remote_exec(self._node)
411 def send_traffic_on_tg(self, duration, rate, framesize,
412 traffic_type, warmup_time=5, async_call=False,
414 """Send traffic from all configured interfaces on TG.
416 :param duration: Duration of test traffic generation in seconds.
417 :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...).
418 :param framesize: Frame size (L2) in Bytes.
419 :param traffic_type: Traffic profile.
420 :param warmup_time: Warmup phase in seconds.
421 :param async_call: Async mode.
422 :param latency: With latency measurement.
426 :type traffic_type: str
427 :type warmup_time: int
428 :type async_call: bool
432 :raises: RuntimeError if TG is not set.
433 :raises: RuntimeError if node is not TG or subtype is not specified.
434 :raises: NotImplementedError if TG is not supported.
439 raise RuntimeError("TG is not set")
441 if node['type'] != NodeType.TG:
442 raise RuntimeError('Node type is not a TG')
444 if node['subtype'] is None:
445 raise RuntimeError('TG subtype not defined')
446 elif node['subtype'] == NodeSubTypeTG.TREX:
447 self.trex_stl_start_remote_exec(int(duration), rate, framesize,
448 traffic_type, async_call, latency,
449 warmup_time=warmup_time)
451 raise NotImplementedError("TG subtype not supported")
455 def no_traffic_loss_occurred(self):
456 """Fail if loss occurred in traffic run.
459 :raises: Exception if loss occured.
461 if self._loss is None:
462 raise Exception('The traffic generation has not been issued')
463 if self._loss != '0':
464 raise Exception('Traffic loss occurred: {0}'.format(self._loss))
466 def partial_traffic_loss_accepted(self, loss_acceptance,
467 loss_acceptance_type):
468 """Fail if loss is higher then accepted in traffic run.
470 :param loss_acceptance: Permitted drop ratio or frames count.
471 :param loss_acceptance_type: Type of permitted loss.
472 :type loss_acceptance: float
473 :type loss_acceptance_type: LossAcceptanceType
475 :raises: Exception if loss is above acceptance criteria.
477 if self._loss is None:
478 raise Exception('The traffic generation has not been issued')
480 if loss_acceptance_type == 'percentage':
481 loss = (float(self._loss) / float(self._sent)) * 100
482 elif loss_acceptance_type == 'frames':
483 loss = float(self._loss)
485 raise Exception('Loss acceptance type not supported')
487 if loss > float(loss_acceptance):
488 raise Exception("Traffic loss {} above loss acceptance: {}".format(
489 loss, loss_acceptance))