-# Copyright (c) 2018 Cisco and/or its affiliates.
+# Copyright (c) 2019 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:
from robot.libraries.BuiltIn import BuiltIn
from .DropRateSearch import DropRateSearch
-from .constants import Constants
+from .Constants import Constants
from .ssh import SSH
from .topology import NodeType
from .topology import NodeSubTypeTG
from .MLRsearch.AbstractMeasurer import AbstractMeasurer
from .MLRsearch.MultipleLossRatioSearch import MultipleLossRatioSearch
from .MLRsearch.ReceiveRateMeasurement import ReceiveRateMeasurement
+from .PLRsearch.PLRsearch import PLRsearch
__all__ = ['TGDropRateSearchImpl', 'TrafficGenerator', 'OptimizedSearch']
super(TGDropRateSearchImpl, self).__init__()
def measure_loss(self, rate, frame_size, loss_acceptance,
- loss_acceptance_type, traffic_type, skip_warmup=False):
+ loss_acceptance_type, traffic_profile, skip_warmup=False):
"""Runs the traffic and evaluate the measured results.
:param rate: Offered traffic load.
:param frame_size: Size of frame.
:param loss_acceptance: Permitted drop ratio or frames count.
:param loss_acceptance_type: Type of permitted loss.
- :param traffic_type: Module name as a traffic type identifier.
+ :param traffic_profile: Module name as a traffic profile identifier.
See resources/traffic_profiles/trex for implemented modules.
:param skip_warmup: Start TRex without warmup traffic if true.
:type rate: float
:type frame_size: str
:type loss_acceptance: float
:type loss_acceptance_type: LossAcceptanceType
- :type traffic_type: str
+ :type traffic_profile: str
:type skip_warmup: bool
:returns: Drop threshold exceeded? (True/False)
:rtype: bool
if skip_warmup:
tg_instance.trex_stl_start_remote_exec(self.get_duration(),
unit_rate, frame_size,
- traffic_type,
+ traffic_profile,
warmup_time=0.0)
else:
tg_instance.trex_stl_start_remote_exec(self.get_duration(),
unit_rate, frame_size,
- traffic_type)
+ traffic_profile)
loss = tg_instance.get_loss()
sent = tg_instance.get_sent()
if self.loss_acceptance_type_is_percentage():
FIXME: Describe API."""
# TODO: Decrease friction between various search and rate provider APIs.
- # FIXME: Remove "trex" from lines which could work with other TGs.
+ # TODO: Remove "trex" from lines which could work with other TGs.
- # use one instance of TrafficGenerator for all tests in test suite
+ # Use one instance of TrafficGenerator for all tests in test suite
ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
def __init__(self):
self._ifaces_reordered = False
# Parameters not given by measure().
self.frame_size = None
- self.traffic_type = None
+ self.traffic_profile = None
self.warmup_time = None
@property
"""
return self._latency
- def initialize_traffic_generator(self, tg_node, tg_if1, tg_if2,
- tg_if1_adj_node, tg_if1_adj_if,
- tg_if2_adj_node, tg_if2_adj_if,
- test_type,
- tg_if1_dst_mac=None, tg_if2_dst_mac=None):
+ def initialize_traffic_generator(
+ self, tg_node, tg_if1, tg_if2, tg_if1_adj_node, tg_if1_adj_if,
+ tg_if2_adj_node, tg_if2_adj_if, osi_layer, tg_if1_dst_mac=None,
+ tg_if2_dst_mac=None):
"""TG initialization.
+ TODO: Document why do we need (and how do we use) _ifaces_reordered.
+
:param tg_node: Traffic generator node.
:param tg_if1: TG - name of first interface.
:param tg_if2: TG - name of second interface.
:param tg_if1_adj_if: TG if1 adjecent interface.
:param tg_if2_adj_node: TG if2 adjecent node.
:param tg_if2_adj_if: TG if2 adjecent interface.
- :param test_type: 'L2', 'L3' or 'L7' - OSI Layer testing type.
+ :param osi_layer: 'L2', 'L3' or 'L7' - OSI Layer testing type.
:param tg_if1_dst_mac: Interface 1 destination MAC address.
:param tg_if2_dst_mac: Interface 2 destination MAC address.
:type tg_node: dict
:type tg_if1_adj_if: str
:type tg_if2_adj_node: dict
:type tg_if2_adj_if: str
- :type test_type: str
+ :type osi_layer: str
:type tg_if1_dst_mac: str
:type tg_if2_dst_mac: str
:returns: nothing
if1_addr = Topology().get_interface_mac(tg_node, tg_if1)
if2_addr = Topology().get_interface_mac(tg_node, tg_if2)
- if test_type == 'L2':
+ if osi_layer == 'L2':
if1_adj_addr = if2_addr
if2_adj_addr = if1_addr
- elif test_type == 'L3':
+ elif osi_layer == 'L3':
if1_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 test_type == 'L7':
+ elif osi_layer == 'L7':
if1_addr = Topology().get_interface_ip4(tg_node, tg_if1)
if2_addr = Topology().get_interface_ip4(tg_node, tg_if2)
if1_adj_addr = Topology().get_interface_ip4(tg_if1_adj_node,
if1_adj_addr, if2_adj_addr = if2_adj_addr, if1_adj_addr
self._ifaces_reordered = True
- if test_type == 'L2' or test_type == 'L3':
+ if osi_layer == 'L2' or osi_layer == 'L3':
(ret, _, _) = ssh.exec_command(
"sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
"- port_limit: 2\n"
"0x"+if1_addr.replace(":", ",0x"),
"0x"+if2_adj_addr.replace(":", ",0x"),
"0x"+if2_addr.replace(":", ",0x")))
- elif test_type == 'L7':
+ elif osi_layer == 'L7':
(ret, _, _) = ssh.exec_command(
"sudo sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
"- port_limit: 2\n"
raise RuntimeError('trex-cfg failed')
# start TRex
- if test_type == 'L2' or test_type == 'L3':
+ if osi_layer == 'L2' or osi_layer == 'L3':
(ret, _, _) = ssh.exec_command(
"sh -c 'cd {0}/scripts/ && "
"sudo nohup ./t-rex-64 -i -c 7 --iom 0 > /tmp/trex.log "
"2>&1 &' > /dev/null"\
.format(Constants.TREX_INSTALL_DIR))
- elif test_type == 'L7':
+ elif osi_layer == 'L7':
(ret, _, _) = ssh.exec_command(
"sh -c 'cd {0}/scripts/ && "
"sudo nohup ./t-rex-64 --astf -i -c 7 --iom 0 > "
if int(ret) != 0:
raise RuntimeError('TRex stateless runtime error')
- def trex_stl_start_remote_exec(self, duration, rate, framesize,
- traffic_type, async_call=False,
- latency=True, warmup_time=5.0):
+ def trex_stl_start_remote_exec(
+ self, duration, rate, frame_size, traffic_profile, async_call=False,
+ latency=True, warmup_time=5.0, unidirection=False, tx_port=0,
+ rx_port=1):
"""Execute script on remote node over ssh to start traffic.
:param duration: Time expresed in seconds for how long to send traffic.
:param rate: Traffic rate expressed with units (pps, %)
- :param framesize: L2 frame size to send (without padding and IPG).
- :param traffic_type: Module name as a traffic type identifier.
+ :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.
:param latency: With latency measurement.
:param warmup_time: Warmup time period.
+ :param unidirection: Traffic is unidirectional. Default: False
+ :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 rate: str
- :type framesize: str
- :type traffic_type: str
+ :type frame_size: str
+ :type traffic_profile: str
:type async_call: bool
:type latency: bool
:type warmup_time: float
- :returns: Nothing
+ :type unidirection: bool
+ :type tx_port: int
+ :type rx_port: int
:raises RuntimeError: In case of TG driver issue.
"""
ssh = SSH()
ssh.connect(self._node)
+ 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)
+ # Values from Robot can introduce type unicode,
+ # we need to encode them, so that repr() does not lead with 'u'.
+ if isinstance(rate, unicode):
+ rate = rate.encode("utf-8")
+ if isinstance(duration, unicode):
+ duration = duration.encode("utf-8")
+ if isinstance(warmup_time, unicode):
+ warmup_time = warmup_time.encode("utf-8")
+ command = (
+ "sh -c '{tool}/resources/tools/trex/trex_stateless_profile.py"
+ " --profile {prof}/resources/traffic_profiles/trex/{traffic}.py"
+ " --duration {duration!r} --frame_size {frame_size} --rate {rate!r}"
+ " --warmup_time {warmup!r} --port_0 {p_0} --port_1 {p_1}").format(
+ tool=Constants.REMOTE_FW_DIR, prof=Constants.REMOTE_FW_DIR,
+ traffic=traffic_profile, duration=duration,
+ frame_size=frame_size, rate=rate, warmup=warmup_time, p_0=p_0,
+ p_1=p_1)
+ if async_call:
+ command += " --async"
+ if latency:
+ command += " --latency"
+ if unidirection:
+ command += " --unidirection"
+ command += "'"
- _async = "--async" if async_call else ""
- _latency = "--latency" if latency else ""
- _p0, _p1 = (2, 1) if self._ifaces_reordered else (1, 2)
-
- profile_path = ("{0}/resources/traffic_profiles/trex/"
- "{1}.py".format(Constants.REMOTE_FW_DIR,
- traffic_type))
(ret, stdout, _) = ssh.exec_command(
- "sh -c "
- "'{0}/resources/tools/trex/trex_stateless_profile.py "
- "--profile {1} "
- "--duration {2} "
- "--frame_size {3} "
- "--rate {4} "
- "--warmup_time {5} "
- "--port_0 {6} "
- "--port_1 {7} "
- "{8} " # --async
- "{9}'". # --latency
- format(Constants.REMOTE_FW_DIR, profile_path, duration, framesize,
- rate, warmup_time, _p0 - 1, _p1 - 1, _async, _latency),
- timeout=float(duration) + 60)
+ command, timeout=float(duration) + 60)
if int(ret) != 0:
raise RuntimeError('TRex stateless runtime error')
else:
# last line from console output
line = stdout.splitlines()[-1]
-
self._result = line
logger.info('TrafficGen result: {0}'.format(self._result))
-
self._received = self._result.split(', ')[1].split('=')[1]
self._sent = self._result.split(', ')[2].split('=')[1]
self._loss = self._result.split(', ')[3].split('=')[1]
-
self._latency = []
self._latency.append(self._result.split(', ')[4].split('=')[1])
self._latency.append(self._result.split(', ')[5].split('=')[1])
if self._node['subtype'] == NodeSubTypeTG.TREX:
self.trex_stl_stop_remote_exec(self._node)
- def send_traffic_on_tg(self, duration, rate, framesize,
- traffic_type, warmup_time=5, async_call=False,
- latency=True):
+ def send_traffic_on_tg(
+ self, duration, rate, frame_size, traffic_profile, warmup_time=5,
+ async_call=False, latency=True, unidirection=False, tx_port=0,
+ rx_port=1):
"""Send traffic from all configured interfaces on TG.
+ Note that bidirectional traffic also contains flows
+ transmitted from rx_port and received in tx_port.
+ But some tests use asymmetric traffic, so those arguments are relevant.
+
+ Also note that traffic generator uses DPDK driver which might
+ reorder port numbers based on wiring and PCI numbering.
+ 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 framesize: Frame size (L2) in Bytes.
- :param traffic_type: Module name as a traffic type identifier.
+ :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.
:param warmup_time: Warmup phase in seconds.
:param async_call: Async mode.
:param latency: With latency measurement.
+ :param unidirection: Traffic is unidirectional. Default: False
+ :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: str
:type rate: str
- :type framesize: str
- :type traffic_type: str
+ :type frame_size: str
+ :type traffic_profile: str
:type warmup_time: float
:type async_call: bool
:type latency: bool
+ :type unidirection: bool
+ :type tx_port: int
+ :type rx_port: int
:returns: TG output.
:rtype: str
:raises RuntimeError: If TG is not set, or if node is not TG,
if node['subtype'] is None:
raise RuntimeError('TG subtype not defined')
elif node['subtype'] == NodeSubTypeTG.TREX:
- self.trex_stl_start_remote_exec(duration, rate, framesize,
- traffic_type, async_call, latency,
- warmup_time=warmup_time)
+ self.trex_stl_start_remote_exec(
+ duration, rate, frame_size, traffic_profile, async_call,
+ latency, warmup_time, unidirection, tx_port, rx_port)
else:
raise NotImplementedError("TG subtype not supported")
raise Exception("Traffic loss {} above loss acceptance: {}".format(
loss, loss_acceptance))
- def set_rate_provider_defaults(self, frame_size, traffic_type,
+ def set_rate_provider_defaults(self, frame_size, traffic_profile,
warmup_time=0.0):
"""Store values accessed by measure().
:param frame_size: Frame size identifier or value [B].
- :param traffic_type: Module name as a traffic type identifier.
+ :param traffic_profile: Module name as a traffic profile identifier.
See resources/traffic_profiles/trex for implemented modules.
:param warmup_time: Traffic duration before measurement starts [s].
:type frame_size: str or int
- :type traffic_type: str
+ :type traffic_profile: str
:type warmup_time: float
"""
self.frame_size = frame_size
- self.traffic_type = str(traffic_type)
+ self.traffic_profile = str(traffic_profile)
self.warmup_time = float(warmup_time)
def measure(self, duration, transmit_rate):
# Trex needs target Tr per stream, but reports aggregate Tx and Dx.
unit_rate = str(transmit_rate / 2.0) + "pps"
self.send_traffic_on_tg(
- duration, unit_rate, self.frame_size, self.traffic_type,
- self.warmup_time, latency=True)
+ duration, unit_rate, self.frame_size, self.traffic_profile,
+ warmup_time=self.warmup_time, latency=True)
transmit_count = int(self.get_sent())
loss_count = int(self.get_loss())
measurement = ReceiveRateMeasurement(
@staticmethod
def perform_optimized_ndrpdr_search(
- frame_size, traffic_type, minimum_transmit_rate,
+ frame_size, traffic_profile, minimum_transmit_rate,
maximum_transmit_rate, packet_loss_ratio=0.005,
final_relative_width=0.005, final_trial_duration=30.0,
initial_trial_duration=1.0, number_of_intermediate_phases=2,
- timeout=600.0):
+ timeout=720.0, doublings=1):
"""Setup initialized TG, perform optimized search, return intervals.
:param frame_size: Frame size identifier or value [B].
- :param traffic_type: Module name as a traffic type identifier.
+ :param traffic_profile: Module name as a traffic profile identifier.
See resources/traffic_profiles/trex for implemented modules.
:param minimum_transmit_rate: Minimal bidirectional
target transmit rate [pps].
to perform before the final phase [1].
:param timeout: The search will fail itself when not finished
before this overall time [s].
+ :param doublings: How many doublings to do in external search step.
+ Default 1 is suitable for fairly stable tests,
+ less stable tests might get better overal duration with 2 or more.
:type frame_size: str or int
- :type traffic_type: str
+ :type traffic_profile: str
:type minimum_transmit_rate: float
:type maximum_transmit_rate: float
:type packet_loss_ratio: float
:type initial_trial_duration: float
:type number_of_intermediate_phases: int
:type timeout: float
+ :type doublings: int
:returns: Structure containing narrowed down NDR and PDR intervals
and their measurements.
:rtype: NdrPdrResult
# to be able to use trex_stl-*()
tg_instance = BuiltIn().get_library_instance(
'resources.libraries.python.TrafficGenerator')
- tg_instance.set_rate_provider_defaults(frame_size, traffic_type)
+ tg_instance.set_rate_provider_defaults(frame_size, traffic_profile)
algorithm = MultipleLossRatioSearch(
measurer=tg_instance, final_trial_duration=final_trial_duration,
final_relative_width=final_relative_width,
number_of_intermediate_phases=number_of_intermediate_phases,
- initial_trial_duration=initial_trial_duration, timeout=timeout)
+ initial_trial_duration=initial_trial_duration, timeout=timeout,
+ doublings=doublings)
result = algorithm.narrow_down_ndr_and_pdr(
minimum_transmit_rate, maximum_transmit_rate, packet_loss_ratio)
return result
+
+ @staticmethod
+ def perform_soak_search(
+ frame_size, traffic_profile, minimum_transmit_rate,
+ maximum_transmit_rate, plr_target=1e-7, tdpt=0.1,
+ initial_count=50, timeout=1800.0, trace_enabled=False):
+ """Setup initialized TG, perform soak search, return avg and stdev.
+
+ :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.
+ :param minimum_transmit_rate: Minimal bidirectional
+ target transmit rate [pps].
+ :param maximum_transmit_rate: Maximal bidirectional
+ target transmit rate [pps].
+ :param plr_target: Fraction of packets lost to achieve [1].
+ :param tdpt: Trial duration per trial.
+ The algorithm linearly increases trial duration with trial number,
+ this is the increment between succesive trials, in seconds.
+ :param initial_count: Offset to apply before the first trial.
+ For example initial_count=50 makes first trial to be 51*tdpt long.
+ This is needed because initial "search" phase of integrator
+ takes significant time even without any trial results.
+ :param timeout: The search will stop after this overall time [s].
+ :type frame_size: str or int
+ :type traffic_profile: str
+ :type minimum_transmit_rate: float
+ :type maximum_transmit_rate: float
+ :type plr_target: float
+ :type initial_count: int
+ :type timeout: float
+ :returns: Average and stdev of estimated bidirectional rate giving PLR.
+ :rtype: 2-tuple of float
+ """
+ tg_instance = BuiltIn().get_library_instance(
+ 'resources.libraries.python.TrafficGenerator')
+ tg_instance.set_rate_provider_defaults(frame_size, traffic_profile)
+ algorithm = PLRsearch(
+ measurer=tg_instance, trial_duration_per_trial=tdpt,
+ packet_loss_ratio_target=plr_target,
+ trial_number_offset=initial_count, timeout=timeout,
+ trace_enabled=trace_enabled)
+ result = algorithm.search(minimum_transmit_rate, maximum_transmit_rate)
+ return result
Code Review / csit.git / blobdiff