X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FTrafficGenerator.py;h=1f753bdcaff74fa1c6fcfd6275545d1203efd73c;hp=a73e471f7717d48ce10c4de67a035c5a9ee611ec;hb=38ba3408ef77161b61cd4be702d0c6e8fc36f8e5;hpb=efcdd3eadfadb2814a9e3b67cce84b5dc89c7108 diff --git a/resources/libraries/python/TrafficGenerator.py b/resources/libraries/python/TrafficGenerator.py index a73e471f77..1f753bdcaf 100644 --- a/resources/libraries/python/TrafficGenerator.py +++ b/resources/libraries/python/TrafficGenerator.py @@ -1,4 +1,4 @@ -# Copyright (c) 2019 Cisco and/or its affiliates. +# Copyright (c) 2020 Cisco and/or its affiliates. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at: @@ -18,16 +18,18 @@ import time from robot.api import logger from robot.libraries.BuiltIn import BuiltIn -from .DropRateSearch import DropRateSearch from .Constants import Constants -from .ssh import exec_cmd_no_error, exec_cmd -from .topology import NodeType -from .topology import NodeSubTypeTG -from .topology import Topology +from .CpuUtils import CpuUtils +from .DropRateSearch import DropRateSearch from .MLRsearch.AbstractMeasurer import AbstractMeasurer from .MLRsearch.MultipleLossRatioSearch import MultipleLossRatioSearch from .MLRsearch.ReceiveRateMeasurement import ReceiveRateMeasurement from .PLRsearch.PLRsearch import PLRsearch +from .OptionString import OptionString +from .ssh import exec_cmd_no_error, exec_cmd +from .topology import NodeType +from .topology import NodeSubTypeTG +from .topology import Topology __all__ = [u"TGDropRateSearchImpl", u"TrafficGenerator", u"OptimizedSearch"] @@ -46,7 +48,7 @@ def check_subtype(node): """ if node.get(u"type") is None: msg = u"Node type is not defined" - elif node['type'] != NodeType.TG: + elif node[u"type"] != NodeType.TG: msg = f"Node type is {node[u'type']!r}, not a TG" elif node.get(u"subtype") is None: msg = u"TG subtype is not defined" @@ -73,7 +75,7 @@ class TGDropRateSearchImpl(DropRateSearch): :param loss_acceptance: Permitted drop ratio or frames count. :param loss_acceptance_type: Type of permitted loss. :param traffic_profile: Module name as a traffic profile identifier. - See resources/traffic_profiles/trex for implemented modules. + See GPL/traffic_profiles/trex for implemented modules. :param skip_warmup: Start TRex without warmup traffic if true. :type rate: float :type frame_size: str @@ -125,23 +127,27 @@ class TGDropRateSearchImpl(DropRateSearch): return tg_instance.get_latency_int() +class TrexMode: + """Defines mode of T-Rex traffic generator.""" + # Advanced stateful mode + ASTF = u"ASTF" + # Stateless mode + STL = u"STL" + + # TODO: Pylint says too-many-instance-attributes. -# A fix is developed in https://gerrit.fd.io/r/c/csit/+/22221 class TrafficGenerator(AbstractMeasurer): - """Traffic Generator. - - FIXME: Describe API.""" + """Traffic Generator.""" - # TODO: Decrease friction between various search and rate provider APIs. # TODO: Remove "trex" from lines which could work with other TGs. # Use one instance of TrafficGenerator for all tests in test suite ROBOT_LIBRARY_SCOPE = u"TEST SUITE" def __init__(self): - # TODO: Number of fields will be reduced with CSIT-1378. self._node = None - # T-REX interface order mapping + self._mode = None + # TG interface order mapping self._ifaces_reordered = False # Result holding fields, to be removed. self._result = None @@ -149,6 +155,9 @@ class TrafficGenerator(AbstractMeasurer): self._sent = None self._latency = None self._received = None + self._approximated_rate = None + self._approximated_duration = None + self._l7_data = None # Measurement input fields, needed for async stop result. self._start_time = None self._rate = None @@ -157,9 +166,10 @@ class TrafficGenerator(AbstractMeasurer): self.traffic_profile = None self.warmup_time = None self.traffic_directions = None + self.negative_loss = None # Transient data needed for async measurements. self._xstats = (None, None) - # TODO: Rename "xstats" to something opaque, so TRex is not privileged? + # TODO: Rename "xstats" to something opaque, so T-Rex is not privileged? @property def node(self): @@ -202,6 +212,36 @@ class TrafficGenerator(AbstractMeasurer): """ return self._latency + def get_approximated_rate(self): + """Return approximated rate computed as ratio of transmitted packets + over duration of trial. + + :returns: Approximated rate. + :rtype: str + """ + return self._approximated_rate + + def get_l7_data(self): + """Return L7 data. + + :returns: Number of received packets. + :rtype: dict + """ + return self._l7_data + + def check_mode(self, expected_mode): + """Check TG mode. + + :param expected_mode: Expected traffic generator mode. + :type expected_mode: object + :raises RuntimeError: In case of unexpected TG mode. + """ + if self._mode == expected_mode: + return + raise RuntimeError( + f"{self._node[u'subtype']} not running in {expected_mode} mode!" + ) + # TODO: pylint says disable=too-many-locals. # A fix is developed in https://gerrit.fd.io/r/c/csit/+/22221 def initialize_traffic_generator( @@ -238,154 +278,159 @@ class TrafficGenerator(AbstractMeasurer): subtype = check_subtype(tg_node) if subtype == NodeSubTypeTG.TREX: self._node = tg_node - - if1_pci = Topology().get_interface_pci_addr(self._node, tg_if1) - if2_pci = Topology().get_interface_pci_addr(self._node, tg_if2) - if1_addr = Topology().get_interface_mac(self._node, tg_if1) - if2_addr = Topology().get_interface_mac(self._node, tg_if2) + self._mode = TrexMode.ASTF if osi_layer == u"L7" else TrexMode.STL + if1 = dict() + if2 = dict() + if1[u"pci"] = Topology().get_interface_pci_addr(self._node, tg_if1) + if2[u"pci"] = Topology().get_interface_pci_addr(self._node, tg_if2) + if1[u"addr"] = Topology().get_interface_mac(self._node, tg_if1) + if2[u"addr"] = Topology().get_interface_mac(self._node, tg_if2) if osi_layer == u"L2": - if1_adj_addr = if2_addr - if2_adj_addr = if1_addr - elif osi_layer == u"L3": - if1_adj_addr = Topology().get_interface_mac( + if1[u"adj_addr"] = if2[u"addr"] + if2[u"adj_addr"] = if1[u"addr"] + elif osi_layer in (u"L3", u"L7"): + if1[u"adj_addr"] = Topology().get_interface_mac( tg_if1_adj_node, tg_if1_adj_if ) - if2_adj_addr = Topology().get_interface_mac( - tg_if2_adj_node, tg_if2_adj_if - ) - elif osi_layer == u"L7": - if1_addr = Topology().get_interface_ip4(self._node, tg_if1) - if2_addr = Topology().get_interface_ip4(self._node, tg_if2) - if1_adj_addr = Topology().get_interface_ip4( - tg_if1_adj_node, tg_if1_adj_if - ) - if2_adj_addr = Topology().get_interface_ip4( + if2[u"adj_addr"] = Topology().get_interface_mac( tg_if2_adj_node, tg_if2_adj_if ) else: - raise ValueError(u"Unknown Test Type") + raise ValueError(u"Unknown OSI layer!") # in case of switched environment we can override MAC addresses if tg_if1_dst_mac is not None and tg_if2_dst_mac is not None: - if1_adj_addr = tg_if1_dst_mac - if2_adj_addr = tg_if2_dst_mac + if1[u"adj_addr"] = tg_if1_dst_mac + if2[u"adj_addr"] = tg_if2_dst_mac - if min(if1_pci, if2_pci) != if1_pci: - if1_pci, if2_pci = if2_pci, if1_pci - if1_addr, if2_addr = if2_addr, if1_addr - if1_adj_addr, if2_adj_addr = if2_adj_addr, if1_adj_addr + if min(if1[u"pci"], if2[u"pci"]) != if1[u"pci"]: + if1, if2 = if2, if1 self._ifaces_reordered = True - if osi_layer in (u"L2", u"L3"): - dst_mac0 = f"0x{if1_adj_addr.replace(u':', u',0x')}" - src_mac0 = f"0x{if1_addr.replace(u':', u',0x')}" - dst_mac1 = f"0x{if2_adj_addr.replace(u':', u',0x')}" - src_mac1 = f"0x{if2_addr.replace(u':', u',0x')}" - exec_cmd_no_error( - self._node, - f"sh -c 'cat << EOF > /etc/trex_cfg.yaml\n" - f"- version: 2\n" - f" limit_memory: {Constants.TREX_LIMIT_MEMORY}\n" - f" interfaces: [\"{if1_pci}\",\"{if2_pci}\"]\n" - f" port_info:\n" - f" - dest_mac: [{dst_mac0}]\n" - f" src_mac: [{src_mac0}]\n" - f" - dest_mac: [{dst_mac1}]\n" - f" src_mac: [{src_mac1}]\n" - f"EOF'", - sudo=True, message=u"TRex config generation error" - ) - elif osi_layer == u"L7": + master_thread_id, latency_thread_id, socket, threads = \ + CpuUtils.get_affinity_trex( + self._node, tg_if1, tg_if2, + tg_dtc=Constants.TREX_CORE_COUNT) + + if osi_layer in (u"L2", u"L3", u"L7"): exec_cmd_no_error( self._node, f"sh -c 'cat << EOF > /etc/trex_cfg.yaml\n" f"- version: 2\n" + f" c: {len(threads)}\n" f" limit_memory: {Constants.TREX_LIMIT_MEMORY}\n" - f" interfaces: [\"{if1_pci}\",\"{if2_pci}\"]\n" + f" interfaces: [\"{if1[u'pci']}\",\"{if2[u'pci']}\"]\n" f" port_info:\n" - f" - ip: [{if1_addr}]\n" - f" default_gw: [{if1_adj_addr}]\n" - f" - ip: [{if2_addr}]\n" - f" default_gw: [{if2_adj_addr}]\n" + f" - dest_mac: \'{if1[u'adj_addr']}\'\n" + f" src_mac: \'{if1[u'addr']}\'\n" + f" - dest_mac: \'{if2[u'adj_addr']}\'\n" + f" src_mac: \'{if2[u'addr']}\'\n" + f" platform :\n" + f" master_thread_id: {master_thread_id}\n" + f" latency_thread_id: {latency_thread_id}\n" + f" dual_if:\n" + f" - socket: {socket}\n" + f" threads: {threads}\n" f"EOF'", - sudo=True, message=u"TRex config generation error" + sudo=True, message=u"T-Rex config generation!" ) else: - raise ValueError(u"Unknown Test Type") + raise ValueError(u"Unknown OSI layer!") - self._startup_trex(osi_layer) + TrafficGenerator.startup_trex( + self._node, osi_layer, subtype=subtype + ) - def _startup_trex(self, osi_layer): + @staticmethod + def startup_trex(tg_node, osi_layer, subtype=None): """Startup sequence for the TRex traffic generator. + :param tg_node: Traffic generator node. :param osi_layer: 'L2', 'L3' or 'L7' - OSI Layer testing type. + :param subtype: Traffic generator sub-type. + :type tg_node: dict :type osi_layer: str - :raises RuntimeError: If node subtype is not a TREX or startup failed. + :type subtype: NodeSubTypeTG + :raises RuntimeError: If T-Rex startup failed. + :raises ValueError: If OSI layer is not supported. """ - # No need to check subtype, we know it is TREX. - for _ in range(0, 3): - # Kill TRex only if it is already running. - cmd = u"sh -c \"pgrep t-rex && pkill t-rex && sleep 3 || true\"" - exec_cmd_no_error( - self._node, cmd, sudo=True, message=u"Kill TRex failed!" - ) - - # Configure TRex. - ports = '' - for port in self._node[u"interfaces"].values(): - ports += f" {port.get(u'pci_address')}" - - cmd = f"sh -c \"cd {Constants.TREX_INSTALL_DIR}/scripts/ && " \ - f"./dpdk_nic_bind.py -u {ports} || true\"" - exec_cmd_no_error( - self._node, cmd, sudo=True, - message=u"Unbind PCI ports from driver failed!" - ) - - # Start TRex. - cmd = f"sh -c \"cd {Constants.TREX_INSTALL_DIR}/scripts/ && " \ - f"nohup ./t-rex-64 -i -c {Constants.TREX_CORE_COUNT} --hdrh " \ - f"{u' --astf' if osi_layer == u'L7' else u''} " \ - f"--prefix $(hostname) {Constants.TREX_EXTRA_CMDLINE} " \ - f"> /tmp/trex.log 2>&1 &\" > /dev/null" - try: - exec_cmd_no_error(self._node, cmd, sudo=True) - except RuntimeError: - cmd = u"sh -c \"cat /tmp/trex.log\"" + if not subtype: + subtype = check_subtype(tg_node) + if subtype == NodeSubTypeTG.TREX: + for _ in range(0, 3): + # Kill TRex only if it is already running. + cmd = u"sh -c \"pgrep t-rex && pkill t-rex && sleep 3 || true\"" exec_cmd_no_error( - self._node, cmd, sudo=True, message=u"Get TRex logs failed!" + tg_node, cmd, sudo=True, message=u"Kill TRex failed!" ) - raise RuntimeError(u"Start TRex failed!") - # Test if TRex starts successfuly. - cmd = f"sh -c \"{Constants.REMOTE_FW_DIR}/resources/tools/trex/" \ - f"trex_server_info.py\"" - try: + # Configure TRex. + ports = '' + for port in tg_node[u"interfaces"].values(): + ports += f" {port.get(u'pci_address')}" + + cmd = f"sh -c \"cd {Constants.TREX_INSTALL_DIR}/scripts/ && " \ + f"./dpdk_nic_bind.py -u {ports} || true\"" exec_cmd_no_error( - self._node, cmd, sudo=True, message=u"Test TRex failed!", - retries=20 + tg_node, cmd, sudo=True, + message=u"Unbind PCI ports from driver failed!" ) - except RuntimeError: - continue - return - # After max retries TRex is still not responding to API critical error - # occurred. - raise RuntimeError(u"Start TRex failed after multiple retries!") + + # Start TRex. + cd_cmd = f"cd '{Constants.TREX_INSTALL_DIR}/scripts/'" + trex_cmd = OptionString([u"nohup", u"./t-rex-64"]) + trex_cmd.add(u"-i") + trex_cmd.add(u"--prefix $(hostname)") + trex_cmd.add(u"--hdrh") + trex_cmd.add(u"--no-scapy-server") + trex_cmd.add_if(u"--astf", osi_layer == u"L7") + # OptionString does not create double space if extra is empty. + trex_cmd.add(f"{Constants.TREX_EXTRA_CMDLINE}") + inner_command = f"{cd_cmd} && {trex_cmd} > /tmp/trex.log 2>&1 &" + cmd = f"sh -c \"{inner_command}\" > /dev/null" + try: + exec_cmd_no_error(tg_node, cmd, sudo=True) + except RuntimeError: + cmd = u"sh -c \"cat /tmp/trex.log\"" + exec_cmd_no_error( + tg_node, cmd, sudo=True, + message=u"Get TRex logs failed!" + ) + raise RuntimeError(u"Start TRex failed!") + + # Test T-Rex API responsiveness. + cmd = u"python3" + cmd += f" {Constants.REMOTE_FW_DIR}/GPL/tools/trex/" + if osi_layer in (u"L2", u"L3"): + cmd += f"trex_stl_assert.py" + elif osi_layer == u"L7": + cmd += f"trex_astf_assert.py" + else: + raise ValueError(u"Unknown OSI layer!") + try: + exec_cmd_no_error( + tg_node, cmd, sudo=True, + message=u"T-Rex API is not responding!", retries=20 + ) + except RuntimeError: + continue + return + # After max retries TRex is still not responding to API critical + # error occurred. + exec_cmd(tg_node, u"cat /tmp/trex.log", sudo=True) + raise RuntimeError(u"Start T-Rex failed after multiple retries!") @staticmethod def is_trex_running(node): - """Check if TRex is running using pidof. + """Check if T-Rex is running using pidof. :param node: Traffic generator node. :type node: dict - :returns: True if TRex is running otherwise False. + :returns: True if T-Rex is running otherwise False. :rtype: bool - :raises RuntimeError: If node type is not a TG. """ - # No need to check subtype, we know it is TREX. - - ret, _, _ = exec_cmd(node, u"pidof t-rex", sudo=True) + ret, _, _ = exec_cmd(node, u"pgrep t-rex", sudo=True) return bool(int(ret) == 0) @staticmethod @@ -396,73 +441,285 @@ class TrafficGenerator(AbstractMeasurer): :type node: dict :returns: nothing :raises RuntimeError: If node type is not a TG, - or if TRex teardown fails. + or if T-Rex teardown fails. """ subtype = check_subtype(node) if subtype == NodeSubTypeTG.TREX: exec_cmd_no_error( - node, u"sh -c \"sudo pkill t-rex && sleep 3\"", - sudo=False, message=u"pkill t-rex failed" + node, + u"sh -c " + u"\"if pgrep t-rex; then sudo pkill t-rex && sleep 3; fi\"", + sudo=False, + message=u"T-Rex kill failed!" ) def _parse_traffic_results(self, stdout): """Parse stdout of scripts into fields of self. Block of code to reuse, by sync start, or stop after async. - TODO: Is the output TG subtype dependent? :param stdout: Text containing the standard output. :type stdout: str """ - # last line from console output - line = stdout.splitlines()[-1] - self._result = line - logger.info(f"TrafficGen result: {self._result}") - self._received = self._result.split(u", ")[1].split(u"=", 1)[1] - self._sent = self._result.split(u", ")[2].split(u"=", 1)[1] - self._loss = self._result.split(u", ")[3].split(u"=", 1)[1] - self._latency = list() - self._latency.append(self._result.split(u", ")[4].split(u"=", 1)[1]) - self._latency.append(self._result.split(u", ")[5].split(u"=", 1)[1]) + subtype = check_subtype(self._node) + if subtype == NodeSubTypeTG.TREX: + # Last line from console output + line = stdout.splitlines()[-1] + results = line.split(",") + if results[-1] == u" ": + results.remove(u" ") + self._result = dict() + for result in results: + key, value = result.split(u"=", maxsplit=1) + self._result[key.strip()] = value + logger.info(f"TrafficGen results:\n{self._result}") + self._received = self._result.get(u"total_received") + self._sent = self._result.get(u"total_sent") + self._loss = self._result.get(u"frame_loss") + self._approximated_duration = \ + self._result.get(u"approximated_duration") + self._approximated_rate = self._result.get(u"approximated_rate") + self._latency = list() + self._latency.append(self._result.get(u"latency_stream_0(usec)")) + self._latency.append(self._result.get(u"latency_stream_1(usec)")) + if self._mode == TrexMode.ASTF: + self._l7_data = dict() + self._l7_data[u"client"] = dict() + self._l7_data[u"client"][u"active_flows"] = \ + self._result.get(u"client_active_flows") + self._l7_data[u"client"][u"established_flows"] = \ + self._result.get(u"client_established_flows") + self._l7_data[u"server"] = dict() + self._l7_data[u"server"][u"active_flows"] = \ + self._result.get(u"server_active_flows") + self._l7_data[u"server"][u"established_flows"] = \ + self._result.get(u"server_established_flows") + if u"udp" in self.traffic_profile: + self._l7_data[u"client"][u"udp"] = dict() + self._l7_data[u"client"][u"udp"][u"established_flows"] = \ + self._result.get(u"client_udp_connects") + self._l7_data[u"client"][u"udp"][u"closed_flows"] = \ + self._result.get(u"client_udp_closed") + self._l7_data[u"server"][u"udp"] = dict() + self._l7_data[u"server"][u"udp"][u"accepted_flows"] = \ + self._result.get(u"server_udp_accepts") + self._l7_data[u"server"][u"udp"][u"closed_flows"] = \ + self._result.get(u"server_udp_closed") + elif u"tcp" in self.traffic_profile: + self._l7_data[u"client"][u"tcp"] = dict() + self._l7_data[u"client"][u"tcp"][u"initiated_flows"] = \ + self._result.get(u"client_tcp_connect_inits") + self._l7_data[u"client"][u"tcp"][u"established_flows"] = \ + self._result.get(u"client_tcp_connects") + self._l7_data[u"client"][u"tcp"][u"closed_flows"] = \ + self._result.get(u"client_tcp_closed") + self._l7_data[u"server"][u"tcp"] = dict() + self._l7_data[u"server"][u"tcp"][u"accepted_flows"] = \ + self._result.get(u"server_tcp_accepts") + self._l7_data[u"server"][u"tcp"][u"established_flows"] = \ + self._result.get(u"server_tcp_connects") + self._l7_data[u"server"][u"tcp"][u"closed_flows"] = \ + self._result.get(u"server_tcp_closed") + + def trex_astf_stop_remote_exec(self, node): + """Execute T-Rex ASTF script on remote node over ssh to stop running + traffic. + + Internal state is updated with measurement results. + + :param node: T-Rex generator node. + :type node: dict + :raises RuntimeError: If stop traffic script fails. + """ + command_line = OptionString().add(u"python3") + dirname = f"{Constants.REMOTE_FW_DIR}/GPL/tools/trex" + command_line.add(f"'{dirname}/trex_astf_stop.py'") + command_line.change_prefix(u"--") + for index, value in enumerate(self._xstats): + if value is not None: + value = value.replace(u"'", u"\"") + command_line.add_equals(f"xstat{index}", f"'{value}'") + stdout, _ = exec_cmd_no_error( + node, command_line, + message=u"T-Rex ASTF runtime error!" + ) + self._parse_traffic_results(stdout) def trex_stl_stop_remote_exec(self, node): - """Execute script on remote node over ssh to stop running traffic. + """Execute T-Rex STL script on remote node over ssh to stop running + traffic. Internal state is updated with measurement results. - :param node: TRex generator node. + :param node: T-Rex generator node. :type node: dict :raises RuntimeError: If stop traffic script fails. """ - # No need to check subtype, we know it is TREX. - x_args = u"" + command_line = OptionString().add(u"python3") + dirname = f"{Constants.REMOTE_FW_DIR}/GPL/tools/trex" + command_line.add(f"'{dirname}/trex_stl_stop.py'") + command_line.change_prefix(u"--") for index, value in enumerate(self._xstats): if value is not None: - # Nested quoting is fun. value = value.replace(u"'", u"\"") - x_args += f" --xstat{index}='\"'\"'{value}'\"'\"'" + command_line.add_equals(f"xstat{index}", f"'{value}'") stdout, _ = exec_cmd_no_error( - node, f"sh -c '{Constants.REMOTE_FW_DIR}/resources/tools/trex/" - f"trex_stateless_stop.py{x_args}'", - message=u"TRex stateless runtime error" + node, command_line, + message=u"T-Rex STL runtime error!" ) self._parse_traffic_results(stdout) + def stop_traffic_on_tg(self): + """Stop all traffic on TG. + + :returns: Structure containing the result of the measurement. + :rtype: ReceiveRateMeasurement + :raises ValueError: If TG traffic profile is not supported. + """ + subtype = check_subtype(self._node) + if subtype == NodeSubTypeTG.TREX: + if u"trex-astf" in self.traffic_profile: + self.trex_astf_stop_remote_exec(self._node) + elif u"trex-sl" in self.traffic_profile: + self.trex_stl_stop_remote_exec(self._node) + else: + raise ValueError(u"Unsupported T-Rex traffic profile!") + + return self.get_measurement_result() + + def trex_astf_start_remote_exec( + self, duration, mult, frame_size, traffic_profile, async_call=False, + latency=True, warmup_time=5.0, traffic_directions=2, tx_port=0, + rx_port=1): + """Execute T-Rex ASTF script on remote node over ssh to start running + traffic. + + In sync mode, measurement results are stored internally. + In async mode, initial data including xstats are stored internally. + + :param duration: Time expresed in seconds for how long to send traffic. + :param mult: Traffic rate expressed with units (pps, %) + :param frame_size: L2 frame size to send (without padding and IPG). + :param traffic_profile: Module name as a traffic profile identifier. + See GPL/traffic_profiles/trex for implemented modules. + :param async_call: If enabled then don't wait for all incoming traffic. + :param latency: With latency measurement. + :param warmup_time: Warmup time period. + :param traffic_directions: Traffic is bi- (2) or uni- (1) directional. + Default: 2 + :param tx_port: Traffic generator transmit port for first flow. + Default: 0 + :param rx_port: Traffic generator receive port for first flow. + Default: 1 + :type duration: float + :type mult: int + :type frame_size: str + :type traffic_profile: str + :type async_call: bool + :type latency: bool + :type warmup_time: float + :type traffic_directions: int + :type tx_port: int + :type rx_port: int + :raises RuntimeError: In case of T-Rex driver issue. + """ + self.check_mode(TrexMode.ASTF) + p_0, p_1 = (rx_port, tx_port) if self._ifaces_reordered \ + else (tx_port, rx_port) + if not isinstance(duration, (float, int)): + duration = float(duration) + if not isinstance(warmup_time, (float, int)): + warmup_time = float(warmup_time) + + command_line = OptionString().add(u"python3") + dirname = f"{Constants.REMOTE_FW_DIR}/GPL/tools/trex" + command_line.add(f"'{dirname}/trex_astf_profile.py'") + command_line.change_prefix(u"--") + dirname = f"{Constants.REMOTE_FW_DIR}/GPL/traffic_profiles/trex" + command_line.add_with_value( + u"profile", f"'{dirname}/{traffic_profile}.py'" + ) + command_line.add_with_value(u"duration", f"{duration!r}") + command_line.add_with_value(u"frame_size", frame_size) + command_line.add_with_value(u"mult", int(mult)) + command_line.add_with_value(u"warmup_time", f"{warmup_time!r}") + command_line.add_with_value(u"port_0", p_0) + command_line.add_with_value(u"port_1", p_1) + command_line.add_with_value(u"traffic_directions", traffic_directions) + command_line.add_if(u"async_start", async_call) + command_line.add_if(u"latency", latency) + command_line.add_if(u"force", Constants.TREX_SEND_FORCE) + + stdout, _ = exec_cmd_no_error( + self._node, command_line, + timeout=int(duration) + 600 if u"tcp" in self.traffic_profile + else 60, + message=u"T-Rex ASTF runtime error!" + ) + + self.traffic_directions = traffic_directions + if async_call: + # no result + self._start_time = time.time() + self._rate = float(mult) + self._received = None + self._sent = None + self._loss = None + self._latency = None + xstats = [None, None] + self._l7_data[u"client"] = dict() + self._l7_data[u"client"][u"active_flows"] = None + self._l7_data[u"client"][u"established_flows"] = None + self._l7_data[u"server"] = dict() + self._l7_data[u"server"][u"active_flows"] = None + self._l7_data[u"server"][u"established_flows"] = None + if u"udp" in self.traffic_profile: + self._l7_data[u"client"][u"udp"] = dict() + self._l7_data[u"client"][u"udp"][u"established_flows"] = None + self._l7_data[u"client"][u"udp"][u"closed_flows"] = None + self._l7_data[u"server"][u"udp"] = dict() + self._l7_data[u"server"][u"udp"][u"accepted_flows"] = None + self._l7_data[u"server"][u"udp"][u"closed_flows"] = None + elif u"tcp" in self.traffic_profile: + self._l7_data[u"client"][u"tcp"] = dict() + self._l7_data[u"client"][u"tcp"][u"initiated_flows"] = None + self._l7_data[u"client"][u"tcp"][u"established_flows"] = None + self._l7_data[u"client"][u"tcp"][u"closed_flows"] = None + self._l7_data[u"server"][u"tcp"] = dict() + self._l7_data[u"server"][u"tcp"][u"accepted_flows"] = None + self._l7_data[u"server"][u"tcp"][u"established_flows"] = None + self._l7_data[u"server"][u"tcp"][u"closed_flows"] = None + else: + logger.warn(u"Unsupported T-Rex ASTF traffic profile!") + index = 0 + for line in stdout.splitlines(): + if f"Xstats snapshot {index}: " in line: + xstats[index] = line[19:] + index += 1 + if index == 2: + break + self._xstats = tuple(xstats) + else: + self._parse_traffic_results(stdout) + self._start_time = None + self._rate = None + def trex_stl_start_remote_exec( self, duration, rate, frame_size, traffic_profile, async_call=False, latency=True, warmup_time=5.0, traffic_directions=2, tx_port=0, rx_port=1): - """Execute script on remote node over ssh to start traffic. + """Execute T-Rex STL script on remote node over ssh to start running + traffic. In sync mode, measurement results are stored internally. In async mode, initial data including xstats are stored internally. - :param duration: Time expresed in seconds for how long to send traffic. + :param duration: Time expressed in seconds for how long to send traffic. :param rate: Traffic rate expressed with units (pps, %) :param frame_size: L2 frame size to send (without padding and IPG). :param traffic_profile: Module name as a traffic profile identifier. - See resources/traffic_profiles/trex for implemented modules. - :param async_call: If enabled then don't wait for all incomming trafic. + See GPL/traffic_profiles/trex for implemented modules. + :param async_call: If enabled then don't wait for all incoming traffic. :param latency: With latency measurement. :param warmup_time: Warmup time period. :param traffic_directions: Traffic is bi- (2) or uni- (1) directional. @@ -481,34 +738,38 @@ class TrafficGenerator(AbstractMeasurer): :type traffic_directions: int :type tx_port: int :type rx_port: int - :raises RuntimeError: In case of TG driver issue. + :raises RuntimeError: In case of T-Rex driver issue. """ - # No need to check subtype, we know it is TREX. - reorder = self._ifaces_reordered # Just to make the next line fit. - p_0, p_1 = (rx_port, tx_port) if reorder else (tx_port, rx_port) - + self.check_mode(TrexMode.STL) + p_0, p_1 = (rx_port, tx_port) if self._ifaces_reordered \ + else (tx_port, rx_port) if not isinstance(duration, (float, int)): duration = float(duration) if not isinstance(warmup_time, (float, int)): warmup_time = float(warmup_time) - command = f"sh -c \"" \ - f"{Constants.REMOTE_FW_DIR}/resources/tools/trex/" \ - f"trex_stateless_profile.py" \ - f" --profile {Constants.REMOTE_FW_DIR}/resources/" \ - f"traffic_profiles/trex/{traffic_profile}.py" \ - f" --duration {duration!r} --frame_size {frame_size} " \ - f"--rate {rate!r} --warmup_time {warmup_time!r} " \ - f"--port_0 {p_0} --port_1 {p_1}" \ - f" --traffic_directions {traffic_directions}" - if async_call: - command += u" --async_start" - if latency: - command += u" --latency" - command += u"\"" + + command_line = OptionString().add(u"python3") + dirname = f"{Constants.REMOTE_FW_DIR}/GPL/tools/trex" + command_line.add(f"'{dirname}/trex_stl_profile.py'") + command_line.change_prefix(u"--") + dirname = f"{Constants.REMOTE_FW_DIR}/GPL/traffic_profiles/trex" + command_line.add_with_value( + u"profile", f"'{dirname}/{traffic_profile}.py'" + ) + command_line.add_with_value(u"duration", f"{duration!r}") + command_line.add_with_value(u"frame_size", frame_size) + command_line.add_with_value(u"rate", f"{rate!r}") + command_line.add_with_value(u"warmup_time", f"{warmup_time!r}") + command_line.add_with_value(u"port_0", p_0) + command_line.add_with_value(u"port_1", p_1) + command_line.add_with_value(u"traffic_directions", traffic_directions) + command_line.add_if(u"async_start", async_call) + command_line.add_if(u"latency", latency) + command_line.add_if(u"force", Constants.TREX_SEND_FORCE) stdout, _ = exec_cmd_no_error( - self._node, command, timeout=float(duration) + 60, - message=u"TRex stateless runtime error" + self._node, command_line, timeout=int(duration) + 60, + message=u"T-Rex STL runtime error" ) self.traffic_directions = traffic_directions @@ -520,6 +781,7 @@ class TrafficGenerator(AbstractMeasurer): self._sent = None self._loss = None self._latency = None + xstats = [None, None] index = 0 for line in stdout.splitlines(): @@ -534,18 +796,6 @@ class TrafficGenerator(AbstractMeasurer): self._start_time = None self._rate = None - def stop_traffic_on_tg(self): - """Stop all traffic on TG. - - :returns: Structure containing the result of the measurement. - :rtype: ReceiveRateMeasurement - :raises RuntimeError: If TG is not set. - """ - subtype = check_subtype(self._node) - if subtype == NodeSubTypeTG.TREX: - self.trex_stl_stop_remote_exec(self._node) - return self.get_measurement_result() - def send_traffic_on_tg( self, duration, rate, frame_size, traffic_profile, warmup_time=5, async_call=False, latency=True, traffic_directions=2, tx_port=0, @@ -566,16 +816,13 @@ class TrafficGenerator(AbstractMeasurer): This method handles that, so argument values are invariant, but you can see swapped valued in debug logs. - TODO: Is it better to have less descriptive argument names - just to make them less probable to be viewed as misleading or confusing? - See https://gerrit.fd.io/r/#/c/17625/11/resources/libraries/python\ - /TrafficGenerator.py@406 - :param duration: Duration of test traffic generation in seconds. - :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...). + :param rate: Traffic rate. + - T-Rex stateless mode => Offered load per interface in pps, + - T-Rex advanced stateful mode => multiplier of profile CPS. :param frame_size: Frame size (L2) in Bytes. :param traffic_profile: Module name as a traffic profile identifier. - See resources/traffic_profiles/trex for implemented modules. + See GPL/traffic_profiles/trex for implemented modules. :param warmup_time: Warmup phase in seconds. :param async_call: Async mode. :param latency: With latency measurement. @@ -585,8 +832,8 @@ class TrafficGenerator(AbstractMeasurer): Default: 0 :param rx_port: Traffic generator receive port for first flow. Default: 1 - :type duration: str - :type rate: str + :type duration: float + :type rate: float :type frame_size: str :type traffic_profile: str :type warmup_time: float @@ -595,18 +842,31 @@ class TrafficGenerator(AbstractMeasurer): :type traffic_directions: int :type tx_port: int :type rx_port: int - :returns: TG output. + :returns: TG results. :rtype: str - :raises RuntimeError: If TG is not set, or if node is not TG, - or if subtype is not specified. - :raises NotImplementedError: If TG is not supported. + :raises ValueError: If TG traffic profile is not supported. """ subtype = check_subtype(self._node) if subtype == NodeSubTypeTG.TREX: - self.trex_stl_start_remote_exec( - duration, rate, frame_size, traffic_profile, async_call, - latency, warmup_time, traffic_directions, tx_port, rx_port - ) + self.set_rate_provider_defaults( + frame_size, traffic_profile, + traffic_directions=traffic_directions) + if u"trex-astf" in self.traffic_profile: + self.trex_astf_start_remote_exec( + duration, int(rate), frame_size, traffic_profile, + async_call, latency, warmup_time, traffic_directions, + tx_port, rx_port + ) + # TODO: rename all t-rex stateless profiles to use 'trex-stl' + elif u"trex-sl" in self.traffic_profile: + unit_rate_str = str(rate) + u"pps" + self.trex_stl_start_remote_exec( + duration, unit_rate_str, frame_size, traffic_profile, + async_call, latency, warmup_time, traffic_directions, + tx_port, rx_port + ) + else: + raise ValueError(u"Unsupported T-Rex traffic profile!") return self._result @@ -660,24 +920,27 @@ class TrafficGenerator(AbstractMeasurer): def set_rate_provider_defaults( self, frame_size, traffic_profile, warmup_time=0.0, - traffic_directions=2): + traffic_directions=2, negative_loss=True): """Store values accessed by measure(). :param frame_size: Frame size identifier or value [B]. :param traffic_profile: Module name as a traffic profile identifier. - See resources/traffic_profiles/trex for implemented modules. + See GPL/traffic_profiles/trex for implemented modules. :param warmup_time: Traffic duration before measurement starts [s]. :param traffic_directions: Traffic is bi- (2) or uni- (1) directional. Default: 2 + :param negative_loss: If false, negative loss is reported as zero loss. :type frame_size: str or int :type traffic_profile: str :type warmup_time: float :type traffic_directions: int + :type negative_loss: bool """ self.frame_size = frame_size self.traffic_profile = str(traffic_profile) self.warmup_time = float(warmup_time) self.traffic_directions = traffic_directions + self.negative_loss = negative_loss def get_measurement_result(self, duration=None, transmit_rate=None): """Return the result of last measurement as ReceiveRateMeasurement. @@ -703,6 +966,8 @@ class TrafficGenerator(AbstractMeasurer): transmit_rate = self._rate * self.traffic_directions transmit_count = int(self.get_sent()) loss_count = int(self.get_loss()) + if loss_count < 0 and not self.negative_loss: + loss_count = 0 measurement = ReceiveRateMeasurement( duration, transmit_rate, transmit_count, loss_count ) @@ -715,22 +980,21 @@ class TrafficGenerator(AbstractMeasurer): Aggregate means sum over traffic directions. :param duration: Trial duration [s]. - :param transmit_rate: Target aggregate transmit rate [pps]. + :param transmit_rate: Target aggregate transmit rate [pps] / Connections + per second (CPS) for UDP/TCP flows. :type duration: float :type transmit_rate: float :returns: Structure containing the result of the measurement. :rtype: ReceiveRateMeasurement - :raises RuntimeError: If TG is not set, or if node is not TG, + :raises RuntimeError: If TG is not set or if node is not TG or if subtype is not specified. :raises NotImplementedError: If TG is not supported. """ duration = float(duration) - transmit_rate = float(transmit_rate) # TG needs target Tr per stream, but reports aggregate Tx and Dx. unit_rate_int = transmit_rate / float(self.traffic_directions) - unit_rate_str = str(unit_rate_int) + u"pps" self.send_traffic_on_tg( - duration, unit_rate_str, self.frame_size, self.traffic_profile, + duration, unit_rate_int, self.frame_size, self.traffic_profile, warmup_time=self.warmup_time, latency=True, traffic_directions=self.traffic_directions ) @@ -755,7 +1019,7 @@ class OptimizedSearch: :param frame_size: Frame size identifier or value [B]. :param traffic_profile: Module name as a traffic profile identifier. - See resources/traffic_profiles/trex for implemented modules. + See GPL/traffic_profiles/trex for implemented modules. :param minimum_transmit_rate: Minimal uni-directional target transmit rate [pps]. :param maximum_transmit_rate: Maximal uni-directional @@ -823,7 +1087,7 @@ class OptimizedSearch: :param frame_size: Frame size identifier or value [B]. :param traffic_profile: Module name as a traffic profile identifier. - See resources/traffic_profiles/trex for implemented modules. + See GPL/traffic_profiles/trex for implemented modules. :param minimum_transmit_rate: Minimal uni-directional target transmit rate [pps]. :param maximum_transmit_rate: Maximal uni-directional @@ -858,7 +1122,8 @@ class OptimizedSearch: u"resources.libraries.python.TrafficGenerator" ) tg_instance.set_rate_provider_defaults( - frame_size, traffic_profile, traffic_directions=traffic_directions) + frame_size, traffic_profile, traffic_directions=traffic_directions, + negative_loss=False) algorithm = PLRsearch( measurer=tg_instance, trial_duration_per_trial=tdpt, packet_loss_ratio_target=plr_target,