resources/libraries/python/TrafficGenerator.py

   1 # Copyright (c) 2019 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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """Performance testing traffic generator library."""
  15
  16 import time
  17
  18 from robot.api import logger
  19 from robot.libraries.BuiltIn import BuiltIn
  20
  21 from .DropRateSearch import DropRateSearch
  22 from .Constants import Constants
  23 from .ssh import exec_cmd_no_error, exec_cmd
  24 from .topology import NodeType
  25 from .topology import NodeSubTypeTG
  26 from .topology import Topology
  27 from .MLRsearch.AbstractMeasurer import AbstractMeasurer
  28 from .MLRsearch.MultipleLossRatioSearch import MultipleLossRatioSearch
  29 from .MLRsearch.ReceiveRateMeasurement import ReceiveRateMeasurement
  30 from .PLRsearch.PLRsearch import PLRsearch
  31
  32 __all__ = ['TGDropRateSearchImpl', 'TrafficGenerator', 'OptimizedSearch']
  33
  34
  35 def check_subtype(node):
  36     """Return supported subtype of given node, or raise an exception.
  37
  38     Currently only one subtype is supported,
  39     but we want our code to be ready for other ones.
  40
  41     :param node: Topology node to check. Can be None.
  42     :type node: dict or NoneType
  43     :returns: Subtype detected.
  44     :rtype: NodeSubTypeTG
  45     :raises RuntimeError: If node is not supported, message explains how.
  46     """
  47     if node.get('type') is None:
  48         raise RuntimeError('Node type is not defined')
  49     elif node['type'] != NodeType.TG:
  50         raise RuntimeError('Node type is {typ!r}, not a TG'.format(
  51             typ=node['type']))
  52     elif node.get('subtype') is None:
  53         raise RuntimeError('TG subtype is not defined')
  54     elif node['subtype'] == NodeSubTypeTG.TREX:
  55         return NodeSubTypeTG.TREX
  56     raise RuntimeError('TG subtype {sub!r} is not supported'.format(
  57         sub=node['subtype']))
  58
  59
  60 class TGDropRateSearchImpl(DropRateSearch):
  61     """Drop Rate Search implementation."""
  62
  63     def __init__(self):
  64         super(TGDropRateSearchImpl, self).__init__()
  65
  66     def measure_loss(self, rate, frame_size, loss_acceptance,
  67                      loss_acceptance_type, traffic_profile, skip_warmup=False):
  68         """Runs the traffic and evaluate the measured results.
  69
  70         :param rate: Offered traffic load.
  71         :param frame_size: Size of frame.
  72         :param loss_acceptance: Permitted drop ratio or frames count.
  73         :param loss_acceptance_type: Type of permitted loss.
  74         :param traffic_profile: Module name as a traffic profile identifier.
  75             See resources/traffic_profiles/trex for implemented modules.
  76         :param skip_warmup: Start TRex without warmup traffic if true.
  77         :type rate: float
  78         :type frame_size: str
  79         :type loss_acceptance: float
  80         :type loss_acceptance_type: LossAcceptanceType
  81         :type traffic_profile: str
  82         :type skip_warmup: bool
  83         :returns: Drop threshold exceeded? (True/False)
  84         :rtype: bool
  85         :raises NotImplementedError: If TG is not supported.
  86         :raises RuntimeError: If TG is not specified.
  87         """
  88         # we need instance of TrafficGenerator instantiated by Robot Framework
  89         # to be able to use trex_stl-*()
  90         tg_instance = BuiltIn().get_library_instance(
  91             'resources.libraries.python.TrafficGenerator')
  92         subtype = check_subtype(tg_instance.node)
  93         if subtype == NodeSubTypeTG.TREX:
  94             unit_rate = str(rate) + self.get_rate_type_str()
  95             if skip_warmup:
  96                 tg_instance.trex_stl_start_remote_exec(
  97                     self.get_duration(), unit_rate, frame_size, traffic_profile,
  98                     warmup_time=0.0)
  99             else:
 100                 tg_instance.trex_stl_start_remote_exec(
 101                     self.get_duration(), unit_rate, frame_size, traffic_profile)
 102             loss = tg_instance.get_loss()
 103             sent = tg_instance.get_sent()
 104             if self.loss_acceptance_type_is_percentage():
 105                 loss = (float(loss) / float(sent)) * 100
 106             logger.trace("comparing: {los} < {acc} {typ}".format(
 107                 los=loss, acc=loss_acceptance, typ=loss_acceptance_type))
 108             return float(loss) <= float(loss_acceptance)
 109
 110     def get_latency(self):
 111         """Returns min/avg/max latency.
 112
 113         :returns: Latency stats.
 114         :rtype: list
 115         """
 116         tg_instance = BuiltIn().get_library_instance(
 117             'resources.libraries.python.TrafficGenerator')
 118         return tg_instance.get_latency_int()
 119
 120
 121 class TrafficGenerator(AbstractMeasurer):
 122     """Traffic Generator.
 123
 124     FIXME: Describe API."""
 125
 126     # TODO: Decrease friction between various search and rate provider APIs.
 127     # TODO: Remove "trex" from lines which could work with other TGs.
 128
 129     # Use one instance of TrafficGenerator for all tests in test suite
 130     ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
 131
 132     def __init__(self):
 133         # TODO: Number of fields will be reduced with CSIT-1378.
 134         self._node = None
 135         # T-REX interface order mapping
 136         self._ifaces_reordered = False
 137         # Result holding fields, to be removed.
 138         self._result = None
 139         self._loss = None
 140         self._sent = None
 141         self._latency = None
 142         self._received = None
 143         # Measurement input fields, needed for async stop result.
 144         self._start_time = None
 145         self._rate = None
 146         # Other input parameters, not knowable from measure() signature.
 147         self.frame_size = None
 148         self.traffic_profile = None
 149         self.warmup_time = None
 150
 151     @property
 152     def node(self):
 153         """Getter.
 154
 155         :returns: Traffic generator node.
 156         :rtype: dict
 157         """
 158         return self._node
 159
 160     def get_loss(self):
 161         """Return number of lost packets.
 162
 163         :returns: Number of lost packets.
 164         :rtype: str
 165         """
 166         return self._loss
 167
 168     def get_sent(self):
 169         """Return number of sent packets.
 170
 171         :returns: Number of sent packets.
 172         :rtype: str
 173         """
 174         return self._sent
 175
 176     def get_received(self):
 177         """Return number of received packets.
 178
 179         :returns: Number of received packets.
 180         :rtype: str
 181         """
 182         return self._received
 183
 184     def get_latency_int(self):
 185         """Return rounded min/avg/max latency.
 186
 187         :returns: Latency stats.
 188         :rtype: list
 189         """
 190         return self._latency
 191
 192     def initialize_traffic_generator(
 193             self, tg_node, tg_if1, tg_if2, tg_if1_adj_node, tg_if1_adj_if,
 194             tg_if2_adj_node, tg_if2_adj_if, osi_layer, tg_if1_dst_mac=None,
 195             tg_if2_dst_mac=None):
 196         """TG initialization.
 197
 198         TODO: Document why do we need (and how do we use) _ifaces_reordered.
 199
 200         :param tg_node: Traffic generator node.
 201         :param tg_if1: TG - name of first interface.
 202         :param tg_if2: TG - name of second interface.
 203         :param tg_if1_adj_node: TG if1 adjecent node.
 204         :param tg_if1_adj_if: TG if1 adjecent interface.
 205         :param tg_if2_adj_node: TG if2 adjecent node.
 206         :param tg_if2_adj_if: TG if2 adjecent interface.
 207         :param osi_layer: 'L2', 'L3' or 'L7' - OSI Layer testing type.
 208         :param tg_if1_dst_mac: Interface 1 destination MAC address.
 209         :param tg_if2_dst_mac: Interface 2 destination MAC address.
 210         :type tg_node: dict
 211         :type tg_if1: str
 212         :type tg_if2: str
 213         :type tg_if1_adj_node: dict
 214         :type tg_if1_adj_if: str
 215         :type tg_if2_adj_node: dict
 216         :type tg_if2_adj_if: str
 217         :type osi_layer: str
 218         :type tg_if1_dst_mac: str
 219         :type tg_if2_dst_mac: str
 220         :returns: nothing
 221         :raises RuntimeError: In case of issue during initialization.
 222         """
 223         subtype = check_subtype(tg_node)
 224         if subtype == NodeSubTypeTG.TREX:
 225             self._node = tg_node
 226
 227             if1_pci = Topology().get_interface_pci_addr(self._node, tg_if1)
 228             if2_pci = Topology().get_interface_pci_addr(self._node, tg_if2)
 229             if1_addr = Topology().get_interface_mac(self._node, tg_if1)
 230             if2_addr = Topology().get_interface_mac(self._node, tg_if2)
 231
 232             if osi_layer == 'L2':
 233                 if1_adj_addr = if2_addr
 234                 if2_adj_addr = if1_addr
 235             elif osi_layer == 'L3':
 236                 if1_adj_addr = Topology().get_interface_mac(tg_if1_adj_node,
 237                                                             tg_if1_adj_if)
 238                 if2_adj_addr = Topology().get_interface_mac(tg_if2_adj_node,
 239                                                             tg_if2_adj_if)
 240             elif osi_layer == 'L7':
 241                 if1_addr = Topology().get_interface_ip4(self._node, tg_if1)
 242                 if2_addr = Topology().get_interface_ip4(self._node, tg_if2)
 243                 if1_adj_addr = Topology().get_interface_ip4(tg_if1_adj_node,
 244                                                             tg_if1_adj_if)
 245                 if2_adj_addr = Topology().get_interface_ip4(tg_if2_adj_node,
 246                                                             tg_if2_adj_if)
 247             else:
 248                 raise ValueError("Unknown Test Type")
 249
 250             # in case of switched environment we can override MAC addresses
 251             if tg_if1_dst_mac is not None and tg_if2_dst_mac is not None:
 252                 if1_adj_addr = tg_if1_dst_mac
 253                 if2_adj_addr = tg_if2_dst_mac
 254
 255             if min(if1_pci, if2_pci) != if1_pci:
 256                 if1_pci, if2_pci = if2_pci, if1_pci
 257                 if1_addr, if2_addr = if2_addr, if1_addr
 258                 if1_adj_addr, if2_adj_addr = if2_adj_addr, if1_adj_addr
 259                 self._ifaces_reordered = True
 260
 261             if osi_layer == 'L2' or osi_layer == 'L3':
 262                 exec_cmd_no_error(
 263                     self._node,
 264                     "sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
 265                     "- version: 2\n"
 266                     "  interfaces: [\"{0}\",\"{1}\"]\n"
 267                     "  port_info:\n"
 268                     "      - dest_mac: [{2}]\n"
 269                     "        src_mac: [{3}]\n"
 270                     "      - dest_mac: [{4}]\n"
 271                     "        src_mac: [{5}]\n"
 272                     "EOF'"\
 273                     .format(if1_pci, if2_pci,
 274                             "0x"+if1_adj_addr.replace(":", ",0x"),
 275                             "0x"+if1_addr.replace(":", ",0x"),
 276                             "0x"+if2_adj_addr.replace(":", ",0x"),
 277                             "0x"+if2_addr.replace(":", ",0x")),
 278                     sudo=True, message='TRex config generation error')
 279             elif osi_layer == 'L7':
 280                 exec_cmd_no_error(
 281                     self._node,
 282                     "sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
 283                     "- version: 2\n"
 284                     "  interfaces: [\"{0}\",\"{1}\"]\n"
 285                     "  port_info:\n"
 286                     "      - ip: [{2}]\n"
 287                     "        default_gw: [{3}]\n"
 288                     "      - ip: [{4}]\n"
 289                     "        default_gw: [{5}]\n"
 290                     "EOF'"\
 291                     .format(if1_pci, if2_pci,
 292                             if1_addr, if1_adj_addr,
 293                             if2_addr, if2_adj_addr),
 294                     sudo=True, message='TRex config generation error')
 295             else:
 296                 raise ValueError("Unknown Test Type")
 297
 298             self._startup_trex(osi_layer)
 299
 300     def _startup_trex(self, osi_layer):
 301         """Startup sequence for the TRex traffic generator.
 302
 303         :param osi_layer: 'L2', 'L3' or 'L7' - OSI Layer testing type.
 304         :type osi_layer: str
 305         :raises RuntimeError: If node subtype is not a TREX or startup failed.
 306         """
 307         # No need to check subtype, we know it is TREX.
 308         for _ in range(0, 3):
 309             # Kill TRex only if it is already running.
 310             cmd = "sh -c 'pgrep t-rex && pkill t-rex && sleep 3 || true'"
 311             exec_cmd_no_error(
 312                 self._node, cmd, sudo=True, message='Kill TRex failed!')
 313
 314             # Configure TRex.
 315             ports = ''
 316             for port in self._node['interfaces'].values():
 317                 ports += ' {pci}'.format(pci=port.get('pci_address'))
 318
 319             cmd = ("sh -c 'cd {dir}/scripts/ && "
 320                    "./dpdk_nic_bind.py -u {ports} || true'"
 321                    .format(dir=Constants.TREX_INSTALL_DIR, ports=ports))
 322             exec_cmd_no_error(
 323                 self._node, cmd, sudo=True,
 324                 message='Unbind PCI ports from driver failed!')
 325
 326             cmd = ("sh -c 'cd {dir}/scripts/ && ./trex-cfg'"
 327                    .format(dir=Constants.TREX_INSTALL_DIR))
 328             exec_cmd_no_error(
 329                 self._node, cmd, sudo=True, message='Config TRex failed!')
 330
 331             # Start TRex.
 332             cmd = ("sh -c 'cd {dir}/scripts/ && "
 333                    "nohup ./t-rex-64 {mode} -i -c 7 > "
 334                    "/tmp/trex.log 2>&1 &' > /dev/null"
 335                    .format(dir=Constants.TREX_INSTALL_DIR,
 336                            mode='--astf' if osi_layer == 'L7' else ''))
 337             try:
 338                 exec_cmd_no_error(self._node, cmd, sudo=True)
 339             except RuntimeError:
 340                 cmd = "sh -c 'cat /tmp/trex.log'"
 341                 exec_cmd_no_error(
 342                     self._node, cmd, sudo=True, message='Get TRex logs failed!')
 343                 raise RuntimeError('Start TRex failed!')
 344
 345             # Test if TRex starts successfuly.
 346             cmd = ("sh -c '{dir}/resources/tools/trex/trex_server_info.py'"
 347                    .format(dir=Constants.REMOTE_FW_DIR))
 348             try:
 349                 exec_cmd_no_error(
 350                     self._node, cmd, sudo=True, message='Test TRex failed!',
 351                     retries=20)
 352             except RuntimeError:
 353                 continue
 354             return
 355         # After max retries TRex is still not responding to API critical error
 356         # occurred.
 357         raise RuntimeError('Start TRex failed after multiple retries!')
 358
 359     @staticmethod
 360     def is_trex_running(node):
 361         """Check if TRex is running using pidof.
 362
 363         :param node: Traffic generator node.
 364         :type node: dict
 365         :returns: True if TRex is running otherwise False.
 366         :rtype: bool
 367         :raises RuntimeError: If node type is not a TG.
 368         """
 369         # No need to check subtype, we know it is TREX.
 370
 371         ret, _, _ = exec_cmd(node, "pidof t-rex", sudo=True)
 372         return bool(int(ret) == 0)
 373
 374     @staticmethod
 375     def teardown_traffic_generator(node):
 376         """TG teardown.
 377
 378         :param node: Traffic generator node.
 379         :type node: dict
 380         :returns: nothing
 381         :raises RuntimeError: If node type is not a TG,
 382             or if TRex teardown fails.
 383         """
 384         subtype = check_subtype(node)
 385         if subtype == NodeSubTypeTG.TREX:
 386             exec_cmd_no_error(
 387                 node, "sh -c 'sudo pkill t-rex && sleep 3'",
 388                 sudo=False, message='pkill t-rex failed')
 389
 390     def _parse_traffic_results(self, stdout):
 391         """Parse stdout of scripts into fieds of self.
 392
 393         Block of code to reuse, by sync start, or stop after async.
 394         TODO: Is the output TG subtype dependent?
 395
 396         :param stdout: Text containing the standard output.
 397         :type stdout: str
 398         """
 399         # last line from console output
 400         line = stdout.splitlines()[-1]
 401         self._result = line
 402         logger.info('TrafficGen result: {0}'.format(self._result))
 403         self._received = self._result.split(', ')[1].split('=')[1]
 404         self._sent = self._result.split(', ')[2].split('=')[1]
 405         self._loss = self._result.split(', ')[3].split('=')[1]
 406         self._latency = []
 407         self._latency.append(self._result.split(', ')[4].split('=')[1])
 408         self._latency.append(self._result.split(', ')[5].split('=')[1])
 409
 410     def trex_stl_stop_remote_exec(self, node):
 411         """Execute script on remote node over ssh to stop running traffic.
 412
 413         Internal state is updated with results.
 414
 415         :param node: TRex generator node.
 416         :type node: dict
 417         :returns: Nothing
 418         :raises RuntimeError: If stop traffic script fails.
 419         """
 420         # No need to check subtype, we know it is TREX.
 421         stdout, _ = exec_cmd_no_error(
 422             node,
 423             "sh -c '{}/resources/tools/trex/"
 424             "trex_stateless_stop.py'".format(Constants.REMOTE_FW_DIR),
 425             message='TRex stateless runtime error')
 426         self._parse_traffic_results(stdout)
 427
 428     def trex_stl_start_remote_exec(
 429             self, duration, rate, frame_size, traffic_profile, async_call=False,
 430             latency=True, warmup_time=5.0, unidirection=False, tx_port=0,
 431             rx_port=1):
 432         """Execute script on remote node over ssh to start traffic.
 433
 434         :param duration: Time expresed in seconds for how long to send traffic.
 435         :param rate: Traffic rate expressed with units (pps, %)
 436         :param frame_size: L2 frame size to send (without padding and IPG).
 437         :param traffic_profile: Module name as a traffic profile identifier.
 438             See resources/traffic_profiles/trex for implemented modules.
 439         :param async_call: If enabled then don't wait for all incomming trafic.
 440         :param latency: With latency measurement.
 441         :param warmup_time: Warmup time period.
 442         :param unidirection: Traffic is unidirectional. Default: False
 443         :param tx_port: Traffic generator transmit port for first flow.
 444             Default: 0
 445         :param rx_port: Traffic generator receive port for first flow.
 446             Default: 1
 447         :type duration: float
 448         :type rate: str
 449         :type frame_size: str
 450         :type traffic_profile: str
 451         :type async_call: bool
 452         :type latency: bool
 453         :type warmup_time: float
 454         :type unidirection: bool
 455         :type tx_port: int
 456         :type rx_port: int
 457         :raises RuntimeError: In case of TG driver issue.
 458         """
 459         # No need to check subtype, we know it is TREX.
 460         reorder = self._ifaces_reordered  # Just to make the next line fit.
 461         p_0, p_1 = (rx_port, tx_port) if reorder else (tx_port, rx_port)
 462         # Values from Robot can introduce type unicode,
 463         # we need to encode them, so that repr() does not lead with 'u'.
 464         if isinstance(rate, unicode):
 465             rate = rate.encode("utf-8")
 466         if not isinstance(duration, (float, int)):
 467             duration = float(duration)
 468         if not isinstance(warmup_time, (float, int)):
 469             warmup_time = float(warmup_time)
 470         command = (
 471             "sh -c '{tool}/resources/tools/trex/trex_stateless_profile.py"
 472             " --profile {prof}/resources/traffic_profiles/trex/{traffic}.py"
 473             " --duration {duration!r} --frame_size {frame_size} --rate {rate!r}"
 474             " --warmup_time {warmup!r} --port_0 {p_0} --port_1 {p_1}").format(
 475                 tool=Constants.REMOTE_FW_DIR, prof=Constants.REMOTE_FW_DIR,
 476                 traffic=traffic_profile, duration=duration,
 477                 frame_size=frame_size, rate=rate, warmup=warmup_time, p_0=p_0,
 478                 p_1=p_1)
 479         if async_call:
 480             command += " --async"
 481         if latency:
 482             command += " --latency"
 483         if unidirection:
 484             command += " --unidirection"
 485         command += "'"
 486
 487         stdout, _ = exec_cmd_no_error(
 488             self._node, command, timeout=float(duration) + 60,
 489             message='TRex stateless runtime error')
 490
 491         if async_call:
 492             #no result
 493             self._start_time = time.time()
 494             self._rate = float(rate[:-3]) if "pps" in rate else rate
 495             self._received = None
 496             self._sent = None
 497             self._loss = None
 498             self._latency = None
 499         else:
 500             self._parse_traffic_results(stdout)
 501             self._start_time = None
 502             self._rate = None
 503
 504     def stop_traffic_on_tg(self):
 505         """Stop all traffic on TG.
 506
 507         :returns: Nothing
 508         :raises RuntimeError: If TG is not set.
 509         """
 510         subtype = check_subtype(self._node)
 511         if subtype == NodeSubTypeTG.TREX:
 512             self.trex_stl_stop_remote_exec(self._node)
 513
 514     def send_traffic_on_tg(
 515             self, duration, rate, frame_size, traffic_profile, warmup_time=5,
 516             async_call=False, latency=True, unidirection=False, tx_port=0,
 517             rx_port=1):
 518         """Send traffic from all configured interfaces on TG.
 519
 520         Note that bidirectional traffic also contains flows
 521         transmitted from rx_port and received in tx_port.
 522         But some tests use asymmetric traffic, so those arguments are relevant.
 523
 524         Also note that traffic generator uses DPDK driver which might
 525         reorder port numbers based on wiring and PCI numbering.
 526         This method handles that, so argument values are invariant,
 527         but you can see swapped valued in debug logs.
 528
 529         TODO: Is it better to have less descriptive argument names
 530         just to make them less probable to be viewed as misleading or confusing?
 531         See https://gerrit.fd.io/r/#/c/17625/11/resources/libraries/python\
 532         /TrafficGenerator.py@406
 533
 534         :param duration: Duration of test traffic generation in seconds.
 535         :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...).
 536         :param frame_size: Frame size (L2) in Bytes.
 537         :param traffic_profile: Module name as a traffic profile identifier.
 538             See resources/traffic_profiles/trex for implemented modules.
 539         :param warmup_time: Warmup phase in seconds.
 540         :param async_call: Async mode.
 541         :param latency: With latency measurement.
 542         :param unidirection: Traffic is unidirectional. Default: False
 543         :param tx_port: Traffic generator transmit port for first flow.
 544             Default: 0
 545         :param rx_port: Traffic generator receive port for first flow.
 546             Default: 1
 547         :type duration: str
 548         :type rate: str
 549         :type frame_size: str
 550         :type traffic_profile: str
 551         :type warmup_time: float
 552         :type async_call: bool
 553         :type latency: bool
 554         :type unidirection: bool
 555         :type tx_port: int
 556         :type rx_port: int
 557         :returns: TG output.
 558         :rtype: str
 559         :raises RuntimeError: If TG is not set, or if node is not TG,
 560             or if subtype is not specified.
 561         :raises NotImplementedError: If TG is not supported.
 562         """
 563         subtype = check_subtype(self._node)
 564         if subtype == NodeSubTypeTG.TREX:
 565             self.trex_stl_start_remote_exec(
 566                 duration, rate, frame_size, traffic_profile, async_call,
 567                 latency, warmup_time, unidirection, tx_port, rx_port)
 568
 569         return self._result
 570
 571     def no_traffic_loss_occurred(self):
 572         """Fail if loss occurred in traffic run.
 573
 574         :returns: nothing
 575         :raises Exception: If loss occured.
 576         """
 577         if self._loss is None:
 578             raise RuntimeError('The traffic generation has not been issued')
 579         if self._loss != '0':
 580             raise RuntimeError('Traffic loss occurred: {0}'.format(self._loss))
 581
 582     def fail_if_no_traffic_forwarded(self):
 583         """Fail if no traffic forwarded.
 584
 585         :returns: nothing
 586         :raises Exception: If no traffic forwarded.
 587         """
 588         if self._received is None:
 589             raise RuntimeError('The traffic generation has not been issued')
 590         if self._received == '0':
 591             raise RuntimeError('No traffic forwarded')
 592
 593     def partial_traffic_loss_accepted(self, loss_acceptance,
 594                                       loss_acceptance_type):
 595         """Fail if loss is higher then accepted in traffic run.
 596
 597         :param loss_acceptance: Permitted drop ratio or frames count.
 598         :param loss_acceptance_type: Type of permitted loss.
 599         :type loss_acceptance: float
 600         :type loss_acceptance_type: LossAcceptanceType
 601         :returns: nothing
 602         :raises Exception: If loss is above acceptance criteria.
 603         """
 604         if self._loss is None:
 605             raise Exception('The traffic generation has not been issued')
 606
 607         if loss_acceptance_type == 'percentage':
 608             loss = (float(self._loss) / float(self._sent)) * 100
 609         elif loss_acceptance_type == 'frames':
 610             loss = float(self._loss)
 611         else:
 612             raise Exception('Loss acceptance type not supported')
 613
 614         if loss > float(loss_acceptance):
 615             raise Exception("Traffic loss {} above loss acceptance: {}".format(
 616                 loss, loss_acceptance))
 617
 618     def set_rate_provider_defaults(self, frame_size, traffic_profile,
 619                                    warmup_time=0.0):
 620         """Store values accessed by measure().
 621
 622         :param frame_size: Frame size identifier or value [B].
 623         :param traffic_profile: Module name as a traffic profile identifier.
 624             See resources/traffic_profiles/trex for implemented modules.
 625         :param warmup_time: Traffic duration before measurement starts [s].
 626         :type frame_size: str or int
 627         :type traffic_profile: str
 628         :type warmup_time: float
 629         """
 630         self.frame_size = frame_size
 631         self.traffic_profile = str(traffic_profile)
 632         self.warmup_time = float(warmup_time)
 633
 634     def get_measurement_result(self, duration=None, transmit_rate=None):
 635         """Return the result of last measurement as ReceiveRateMeasurement.
 636
 637         Separate function, as measurements can end either by time
 638         or by explicit call, this is the common block at the end.
 639
 640         TODO: Fail on running or already reported measurement.
 641
 642         :param duration: Measurement duration [s] if known beforehand.
 643             For explicitly stopped measurement it is estimated.
 644         :param transmit_rate: Target aggregate transmit rate [pps].
 645             If not given, computed assuming it was bidirectional.
 646         :type duration: float or NoneType
 647         :type transmit_rate: float or NoneType
 648         :returns: Structure containing the result of the measurement.
 649         :rtype: ReceiveRateMeasurement
 650         """
 651         if duration is None:
 652             duration = time.time() - self._start_time
 653             self._start_time = None
 654         if transmit_rate is None:
 655             # Assuming bi-directional traffic here.
 656             transmit_rate = self._rate * 2.0
 657         transmit_count = int(self.get_sent())
 658         loss_count = int(self.get_loss())
 659         measurement = ReceiveRateMeasurement(
 660             duration, transmit_rate, transmit_count, loss_count)
 661         measurement.latency = self.get_latency_int()
 662         return measurement
 663
 664     def measure(self, duration, transmit_rate):
 665         """Run bi-directional measurement, parse and return results.
 666
 667         :param duration: Trial duration [s].
 668         :param transmit_rate: Target bidirectional transmit rate [pps].
 669         :type duration: float
 670         :type transmit_rate: float
 671         :returns: Structure containing the result of the measurement.
 672         :rtype: ReceiveRateMeasurement
 673         :raises RuntimeError: If TG is not set, or if node is not TG,
 674             or if subtype is not specified.
 675         :raises NotImplementedError: If TG is not supported.
 676         """
 677         duration = float(duration)
 678         transmit_rate = float(transmit_rate)
 679         # TG needs target Tr per stream, but reports aggregate Tx and Dx.
 680         unit_rate = str(transmit_rate / 2.0) + "pps"
 681         self.send_traffic_on_tg(
 682             duration, unit_rate, self.frame_size, self.traffic_profile,
 683             warmup_time=self.warmup_time, latency=True)
 684         return self.get_measurement_result(duration, transmit_rate)
 685
 686
 687 class OptimizedSearch(object):
 688     """Class to be imported as Robot Library, containing a single keyword."""
 689
 690     @staticmethod
 691     def perform_optimized_ndrpdr_search(
 692             frame_size, traffic_profile, minimum_transmit_rate,
 693             maximum_transmit_rate, packet_loss_ratio=0.005,
 694             final_relative_width=0.005, final_trial_duration=30.0,
 695             initial_trial_duration=1.0, number_of_intermediate_phases=2,
 696             timeout=720.0, doublings=1):
 697         """Setup initialized TG, perform optimized search, return intervals.
 698
 699         :param frame_size: Frame size identifier or value [B].
 700         :param traffic_profile: Module name as a traffic profile identifier.
 701             See resources/traffic_profiles/trex for implemented modules.
 702         :param minimum_transmit_rate: Minimal bidirectional
 703             target transmit rate [pps].
 704         :param maximum_transmit_rate: Maximal bidirectional
 705             target transmit rate [pps].
 706         :param packet_loss_ratio: Fraction of packets lost, for PDR [1].
 707         :param final_relative_width: Final lower bound transmit rate
 708             cannot be more distant that this multiple of upper bound [1].
 709         :param final_trial_duration: Trial duration for the final phase [s].
 710         :param initial_trial_duration: Trial duration for the initial phase
 711             and also for the first intermediate phase [s].
 712         :param number_of_intermediate_phases: Number of intermediate phases
 713             to perform before the final phase [1].
 714         :param timeout: The search will fail itself when not finished
 715             before this overall time [s].
 716         :param doublings: How many doublings to do in external search step.
 717             Default 1 is suitable for fairly stable tests,
 718             less stable tests might get better overal duration with 2 or more.
 719         :type frame_size: str or int
 720         :type traffic_profile: str
 721         :type minimum_transmit_rate: float
 722         :type maximum_transmit_rate: float
 723         :type packet_loss_ratio: float
 724         :type final_relative_width: float
 725         :type final_trial_duration: float
 726         :type initial_trial_duration: float
 727         :type number_of_intermediate_phases: int
 728         :type timeout: float
 729         :type doublings: int
 730         :returns: Structure containing narrowed down NDR and PDR intervals
 731             and their measurements.
 732         :rtype: NdrPdrResult
 733         :raises RuntimeError: If total duration is larger than timeout.
 734         """
 735         # we need instance of TrafficGenerator instantiated by Robot Framework
 736         # to be able to use trex_stl-*()
 737         tg_instance = BuiltIn().get_library_instance(
 738             'resources.libraries.python.TrafficGenerator')
 739         tg_instance.set_rate_provider_defaults(frame_size, traffic_profile)
 740         algorithm = MultipleLossRatioSearch(
 741             measurer=tg_instance, final_trial_duration=final_trial_duration,
 742             final_relative_width=final_relative_width,
 743             number_of_intermediate_phases=number_of_intermediate_phases,
 744             initial_trial_duration=initial_trial_duration, timeout=timeout,
 745             doublings=doublings)
 746         result = algorithm.narrow_down_ndr_and_pdr(
 747             minimum_transmit_rate, maximum_transmit_rate, packet_loss_ratio)
 748         return result
 749
 750     @staticmethod
 751     def perform_soak_search(
 752             frame_size, traffic_profile, minimum_transmit_rate,
 753             maximum_transmit_rate, plr_target=1e-7, tdpt=0.1,
 754             initial_count=50, timeout=1800.0, trace_enabled=False):
 755         """Setup initialized TG, perform soak search, return avg and stdev.
 756
 757         :param frame_size: Frame size identifier or value [B].
 758         :param traffic_profile: Module name as a traffic profile identifier.
 759             See resources/traffic_profiles/trex for implemented modules.
 760         :param minimum_transmit_rate: Minimal bidirectional
 761             target transmit rate [pps].
 762         :param maximum_transmit_rate: Maximal bidirectional
 763             target transmit rate [pps].
 764         :param plr_target: Fraction of packets lost to achieve [1].
 765         :param tdpt: Trial duration per trial.
 766             The algorithm linearly increases trial duration with trial number,
 767             this is the increment between succesive trials, in seconds.
 768         :param initial_count: Offset to apply before the first trial.
 769             For example initial_count=50 makes first trial to be 51*tdpt long.
 770             This is needed because initial "search" phase of integrator
 771             takes significant time even without any trial results.
 772         :param timeout: The search will stop after this overall time [s].
 773         :type frame_size: str or int
 774         :type traffic_profile: str
 775         :type minimum_transmit_rate: float
 776         :type maximum_transmit_rate: float
 777         :type plr_target: float
 778         :type initial_count: int
 779         :type timeout: float
 780         :returns: Average and stdev of estimated bidirectional rate giving PLR.
 781         :rtype: 2-tuple of float
 782         """
 783         tg_instance = BuiltIn().get_library_instance(
 784             'resources.libraries.python.TrafficGenerator')
 785         tg_instance.set_rate_provider_defaults(frame_size, traffic_profile)
 786         algorithm = PLRsearch(
 787             measurer=tg_instance, trial_duration_per_trial=tdpt,
 788             packet_loss_ratio_target=plr_target,
 789             trial_number_offset=initial_count, timeout=timeout,
 790             trace_enabled=trace_enabled)
 791         result = algorithm.search(minimum_transmit_rate, maximum_transmit_rate)
 792         return result