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:
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."""
18 from robot.api import logger
19 from robot.libraries.BuiltIn import BuiltIn
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
32 __all__ = ['TGDropRateSearchImpl', 'TrafficGenerator', 'OptimizedSearch']
35 def check_subtype(node):
36 """Return supported subtype of given node, or raise an exception.
38 Currently only one subtype is supported,
39 but we want our code to be ready for other ones.
41 :param node: Topology node to check. Can be None.
42 :type node: dict or NoneType
43 :returns: Subtype detected.
45 :raises RuntimeError: If node is not supported, message explains how.
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(
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(
60 class TGDropRateSearchImpl(DropRateSearch):
61 """Drop Rate Search implementation."""
64 super(TGDropRateSearchImpl, self).__init__()
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.
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.
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)
85 :raises NotImplementedError: If TG is not supported.
86 :raises RuntimeError: If TG is not specified.
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()
96 tg_instance.trex_stl_start_remote_exec(
97 self.get_duration(), unit_rate, frame_size, traffic_profile,
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)
110 def get_latency(self):
111 """Returns min/avg/max latency.
113 :returns: Latency stats.
116 tg_instance = BuiltIn().get_library_instance(
117 'resources.libraries.python.TrafficGenerator')
118 return tg_instance.get_latency_int()
121 class TrafficGenerator(AbstractMeasurer):
122 """Traffic Generator.
124 FIXME: Describe API."""
126 # TODO: Decrease friction between various search and rate provider APIs.
127 # TODO: Remove "trex" from lines which could work with other TGs.
129 # Use one instance of TrafficGenerator for all tests in test suite
130 ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
133 # TODO: Number of fields will be reduced with CSIT-1378.
135 # T-REX interface order mapping
136 self._ifaces_reordered = False
137 # Result holding fields, to be removed.
142 self._received = None
143 # Measurement input fields, needed for async stop result.
144 self._start_time = 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
155 :returns: Traffic generator node.
161 """Return number of lost packets.
163 :returns: Number of lost packets.
169 """Return number of sent packets.
171 :returns: Number of sent packets.
176 def get_received(self):
177 """Return number of received packets.
179 :returns: Number of received packets.
182 return self._received
184 def get_latency_int(self):
185 """Return rounded min/avg/max latency.
187 :returns: Latency stats.
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.
198 TODO: Document why do we need (and how do we use) _ifaces_reordered.
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.
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
218 :type tg_if1_dst_mac: str
219 :type tg_if2_dst_mac: str
221 :raises RuntimeError: In case of issue during initialization.
223 subtype = check_subtype(tg_node)
224 if subtype == NodeSubTypeTG.TREX:
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)
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,
238 if2_adj_addr = Topology().get_interface_mac(tg_if2_adj_node,
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,
245 if2_adj_addr = Topology().get_interface_ip4(tg_if2_adj_node,
248 raise ValueError("Unknown Test Type")
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
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
261 if osi_layer == 'L2' or osi_layer == 'L3':
264 "sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
266 " interfaces: [\"{0}\",\"{1}\"]\n"
268 " - dest_mac: [{2}]\n"
270 " - dest_mac: [{4}]\n"
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':
282 "sh -c 'cat << EOF > /etc/trex_cfg.yaml\n"
284 " interfaces: [\"{0}\",\"{1}\"]\n"
287 " default_gw: [{3}]\n"
289 " default_gw: [{5}]\n"
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')
296 raise ValueError("Unknown Test Type")
298 self._startup_trex(osi_layer)
300 def _startup_trex(self, osi_layer):
301 """Startup sequence for the TRex traffic generator.
303 :param osi_layer: 'L2', 'L3' or 'L7' - OSI Layer testing type.
305 :raises RuntimeError: If node subtype is not a TREX or startup failed.
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'"
312 self._node, cmd, sudo=True, message='Kill TRex failed!')
316 for port in self._node['interfaces'].values():
317 ports += ' {pci}'.format(pci=port.get('pci_address'))
319 cmd = ("sh -c 'cd {dir}/scripts/ && "
320 "./dpdk_nic_bind.py -u {ports} || true'"
321 .format(dir=Constants.TREX_INSTALL_DIR, ports=ports))
323 self._node, cmd, sudo=True,
324 message='Unbind PCI ports from driver failed!')
326 cmd = ("sh -c 'cd {dir}/scripts/ && ./trex-cfg "
327 "--unbind-unused-ports'"
328 .format(dir=Constants.TREX_INSTALL_DIR))
330 self._node, cmd, sudo=True, message='Config TRex failed!')
333 cmd = ("sh -c 'cd {dir}/scripts/ && "
334 "nohup ./t-rex-64 {mode} -i -c 7 > "
335 "/tmp/trex.log 2>&1 &' > /dev/null"
336 .format(dir=Constants.TREX_INSTALL_DIR,
337 mode='--astf' if osi_layer == 'L7' else ''))
339 exec_cmd_no_error(self._node, cmd, sudo=True)
341 cmd = "sh -c 'cat /tmp/trex.log'"
343 self._node, cmd, sudo=True, message='Get TRex logs failed!')
344 raise RuntimeError('Start TRex failed!')
346 # Test if TRex starts successfuly.
347 cmd = ("sh -c '{dir}/resources/tools/trex/trex_server_info.py'"
348 .format(dir=Constants.REMOTE_FW_DIR))
351 self._node, cmd, sudo=True, message='Test TRex failed!',
356 # After max retries TRex is still not responding to API critical error
358 raise RuntimeError('Start TRex failed after multiple retries!')
361 def is_trex_running(node):
362 """Check if TRex is running using pidof.
364 :param node: Traffic generator node.
366 :returns: True if TRex is running otherwise False.
368 :raises RuntimeError: If node type is not a TG.
370 # No need to check subtype, we know it is TREX.
372 ret, _, _ = exec_cmd(node, "pidof t-rex", sudo=True)
373 return bool(int(ret) == 0)
376 def teardown_traffic_generator(node):
379 :param node: Traffic generator node.
382 :raises RuntimeError: If node type is not a TG,
383 or if TRex teardown fails.
385 subtype = check_subtype(node)
386 if subtype == NodeSubTypeTG.TREX:
388 node, "sh -c 'sudo pkill t-rex && sleep 3'",
389 sudo=False, message='pkill t-rex failed')
391 def _parse_traffic_results(self, stdout):
392 """Parse stdout of scripts into fieds of self.
394 Block of code to reuse, by sync start, or stop after async.
395 TODO: Is the output TG subtype dependent?
397 :param stdout: Text containing the standard output.
400 # last line from console output
401 line = stdout.splitlines()[-1]
403 logger.info('TrafficGen result: {0}'.format(self._result))
404 self._received = self._result.split(', ')[1].split('=')[1]
405 self._sent = self._result.split(', ')[2].split('=')[1]
406 self._loss = self._result.split(', ')[3].split('=')[1]
408 self._latency.append(self._result.split(', ')[4].split('=')[1])
409 self._latency.append(self._result.split(', ')[5].split('=')[1])
411 def trex_stl_stop_remote_exec(self, node):
412 """Execute script on remote node over ssh to stop running traffic.
414 Internal state is updated with results.
416 :param node: TRex generator node.
419 :raises RuntimeError: If stop traffic script fails.
421 # No need to check subtype, we know it is TREX.
422 stdout, _ = exec_cmd_no_error(
424 "sh -c '{}/resources/tools/trex/"
425 "trex_stateless_stop.py'".format(Constants.REMOTE_FW_DIR),
426 message='TRex stateless runtime error')
427 self._parse_traffic_results(stdout)
429 def trex_stl_start_remote_exec(
430 self, duration, rate, frame_size, traffic_profile, async_call=False,
431 latency=True, warmup_time=5.0, traffic_directions=2, tx_port=0,
433 """Execute script on remote node over ssh to start traffic.
435 :param duration: Time expresed in seconds for how long to send traffic.
436 :param rate: Traffic rate expressed with units (pps, %)
437 :param frame_size: L2 frame size to send (without padding and IPG).
438 :param traffic_profile: Module name as a traffic profile identifier.
439 See resources/traffic_profiles/trex for implemented modules.
440 :param async_call: If enabled then don't wait for all incomming trafic.
441 :param latency: With latency measurement.
442 :param warmup_time: Warmup time period.
443 :param traffic_directions: Traffic is bi- (2) or uni- (1) directional.
445 :param tx_port: Traffic generator transmit port for first flow.
447 :param rx_port: Traffic generator receive port for first flow.
449 :type duration: float
451 :type frame_size: str
452 :type traffic_profile: str
453 :type async_call: bool
455 :type warmup_time: float
456 :type traffic_directions: int
459 :raises RuntimeError: In case of TG driver issue.
461 # No need to check subtype, we know it is TREX.
462 reorder = self._ifaces_reordered # Just to make the next line fit.
463 p_0, p_1 = (rx_port, tx_port) if reorder else (tx_port, rx_port)
464 # Values from Robot can introduce type unicode,
465 # we need to encode them, so that repr() does not lead with 'u'.
466 if isinstance(rate, unicode):
467 rate = rate.encode("utf-8")
468 if not isinstance(duration, (float, int)):
469 duration = float(duration)
470 if not isinstance(warmup_time, (float, int)):
471 warmup_time = float(warmup_time)
473 "sh -c '{tool}/resources/tools/trex/trex_stateless_profile.py"
474 " --profile {prof}/resources/traffic_profiles/trex/{traffic}.py"
475 " --duration {duration!r} --frame_size {frame_size} --rate {rate!r}"
476 " --warmup_time {warmup!r} --port_0 {p_0} --port_1 {p_1}"
477 " --traffic_directions {dirs}").format(
478 tool=Constants.REMOTE_FW_DIR, prof=Constants.REMOTE_FW_DIR,
479 traffic=traffic_profile, duration=duration,
480 frame_size=frame_size, rate=rate, warmup=warmup_time, p_0=p_0,
481 p_1=p_1, dirs=traffic_directions)
483 command += " --async"
485 command += " --latency"
488 stdout, _ = exec_cmd_no_error(
489 self._node, command, timeout=float(duration) + 60,
490 message='TRex stateless runtime error')
494 self._start_time = time.time()
495 self._rate = float(rate[:-3]) if "pps" in rate else rate
496 self._received = None
501 self._parse_traffic_results(stdout)
502 self._start_time = None
505 def stop_traffic_on_tg(self):
506 """Stop all traffic on TG.
509 :raises RuntimeError: If TG is not set.
511 subtype = check_subtype(self._node)
512 if subtype == NodeSubTypeTG.TREX:
513 self.trex_stl_stop_remote_exec(self._node)
515 def send_traffic_on_tg(
516 self, duration, rate, frame_size, traffic_profile, warmup_time=5,
517 async_call=False, latency=True, traffic_directions=2, tx_port=0,
519 """Send traffic from all configured interfaces on TG.
521 Note that bidirectional traffic also contains flows
522 transmitted from rx_port and received in tx_port.
523 But some tests use asymmetric traffic, so those arguments are relevant.
525 Also note that traffic generator uses DPDK driver which might
526 reorder port numbers based on wiring and PCI numbering.
527 This method handles that, so argument values are invariant,
528 but you can see swapped valued in debug logs.
530 TODO: Is it better to have less descriptive argument names
531 just to make them less probable to be viewed as misleading or confusing?
532 See https://gerrit.fd.io/r/#/c/17625/11/resources/libraries/python\
533 /TrafficGenerator.py@406
535 :param duration: Duration of test traffic generation in seconds.
536 :param rate: Offered load per interface (e.g. 1%, 3gbps, 4mpps, ...).
537 :param frame_size: Frame size (L2) in Bytes.
538 :param traffic_profile: Module name as a traffic profile identifier.
539 See resources/traffic_profiles/trex for implemented modules.
540 :param warmup_time: Warmup phase in seconds.
541 :param async_call: Async mode.
542 :param latency: With latency measurement.
543 :param traffic_directions: Traffic is bi- (2) or uni- (1) directional.
545 :param tx_port: Traffic generator transmit port for first flow.
547 :param rx_port: Traffic generator receive port for first flow.
551 :type frame_size: str
552 :type traffic_profile: str
553 :type warmup_time: float
554 :type async_call: bool
556 :type traffic_directions: int
561 :raises RuntimeError: If TG is not set, or if node is not TG,
562 or if subtype is not specified.
563 :raises NotImplementedError: If TG is not supported.
565 subtype = check_subtype(self._node)
566 if subtype == NodeSubTypeTG.TREX:
567 self.trex_stl_start_remote_exec(
568 duration, rate, frame_size, traffic_profile, async_call,
569 latency, warmup_time, traffic_directions, tx_port, rx_port)
573 def no_traffic_loss_occurred(self):
574 """Fail if loss occurred in traffic run.
577 :raises Exception: If loss occured.
579 if self._loss is None:
580 raise RuntimeError('The traffic generation has not been issued')
581 if self._loss != '0':
582 raise RuntimeError('Traffic loss occurred: {0}'.format(self._loss))
584 def fail_if_no_traffic_forwarded(self):
585 """Fail if no traffic forwarded.
588 :raises Exception: If no traffic forwarded.
590 if self._received is None:
591 raise RuntimeError('The traffic generation has not been issued')
592 if self._received == '0':
593 raise RuntimeError('No traffic forwarded')
595 def partial_traffic_loss_accepted(self, loss_acceptance,
596 loss_acceptance_type):
597 """Fail if loss is higher then accepted in traffic run.
599 :param loss_acceptance: Permitted drop ratio or frames count.
600 :param loss_acceptance_type: Type of permitted loss.
601 :type loss_acceptance: float
602 :type loss_acceptance_type: LossAcceptanceType
604 :raises Exception: If loss is above acceptance criteria.
606 if self._loss is None:
607 raise Exception('The traffic generation has not been issued')
609 if loss_acceptance_type == 'percentage':
610 loss = (float(self._loss) / float(self._sent)) * 100
611 elif loss_acceptance_type == 'frames':
612 loss = float(self._loss)
614 raise Exception('Loss acceptance type not supported')
616 if loss > float(loss_acceptance):
617 raise Exception("Traffic loss {} above loss acceptance: {}".format(
618 loss, loss_acceptance))
620 def set_rate_provider_defaults(self, frame_size, traffic_profile,
621 warmup_time=0.0, traffic_directions=2):
622 """Store values accessed by measure().
624 :param frame_size: Frame size identifier or value [B].
625 :param traffic_profile: Module name as a traffic profile identifier.
626 See resources/traffic_profiles/trex for implemented modules.
627 :param warmup_time: Traffic duration before measurement starts [s].
628 :param traffic_directions: Traffic is bi- (2) or uni- (1) directional.
630 :type frame_size: str or int
631 :type traffic_profile: str
632 :type warmup_time: float
633 :type traffic_directions: int
635 self.frame_size = frame_size
636 self.traffic_profile = str(traffic_profile)
637 self.warmup_time = float(warmup_time)
638 self.traffic_directions = traffic_directions
640 def get_measurement_result(self, duration=None, transmit_rate=None):
641 """Return the result of last measurement as ReceiveRateMeasurement.
643 Separate function, as measurements can end either by time
644 or by explicit call, this is the common block at the end.
646 TODO: Fail on running or already reported measurement.
648 :param duration: Measurement duration [s] if known beforehand.
649 For explicitly stopped measurement it is estimated.
650 :param transmit_rate: Target aggregate transmit rate [pps].
651 If not given, computed assuming it was bidirectional.
652 :type duration: float or NoneType
653 :type transmit_rate: float or NoneType
654 :returns: Structure containing the result of the measurement.
655 :rtype: ReceiveRateMeasurement
658 duration = time.time() - self._start_time
659 self._start_time = None
660 if transmit_rate is None:
661 transmit_rate = self._rate * (1.0 if self.uinidirection else 2.0)
662 transmit_count = int(self.get_sent())
663 loss_count = int(self.get_loss())
664 measurement = ReceiveRateMeasurement(
665 duration, transmit_rate, transmit_count, loss_count)
666 measurement.latency = self.get_latency_int()
669 def measure(self, duration, transmit_rate):
670 """Run trial measurement, parse and return aggregate results.
672 Aggregate means sum over traffic directions.
674 :param duration: Trial duration [s].
675 :param transmit_rate: Target aggregate transmit rate [pps].
676 :type duration: float
677 :type transmit_rate: float
678 :returns: Structure containing the result of the measurement.
679 :rtype: ReceiveRateMeasurement
680 :raises RuntimeError: If TG is not set, or if node is not TG,
681 or if subtype is not specified.
682 :raises NotImplementedError: If TG is not supported.
684 duration = float(duration)
685 transmit_rate = float(transmit_rate)
686 # TG needs target Tr per stream, but reports aggregate Tx and Dx.
687 unit_rate_int = transmit_rate / float(self.traffic_directions)
688 unit_rate_str = str(unit_rate_int) + "pps"
689 self.send_traffic_on_tg(
690 duration, unit_rate_str, self.frame_size, self.traffic_profile,
691 warmup_time=self.warmup_time, latency=True,
692 traffic_directions=self.traffic_directions)
693 return self.get_measurement_result(duration, transmit_rate)
696 class OptimizedSearch(object):
697 """Class to be imported as Robot Library, containing search keywords.
699 Aside of setting up measurer and forwarding arguments,
700 the main business is to translate min/max rate from unidir to aggregate.
704 def perform_optimized_ndrpdr_search(
705 frame_size, traffic_profile, minimum_transmit_rate,
706 maximum_transmit_rate, packet_loss_ratio=0.005,
707 final_relative_width=0.005, final_trial_duration=30.0,
708 initial_trial_duration=1.0, number_of_intermediate_phases=2,
709 timeout=720.0, doublings=1, traffic_directions=2):
710 """Setup initialized TG, perform optimized search, return intervals.
712 :param frame_size: Frame size identifier or value [B].
713 :param traffic_profile: Module name as a traffic profile identifier.
714 See resources/traffic_profiles/trex for implemented modules.
715 :param minimum_transmit_rate: Minimal uni-directional
716 target transmit rate [pps].
717 :param maximum_transmit_rate: Maximal uni-directional
718 target transmit rate [pps].
719 :param packet_loss_ratio: Fraction of packets lost, for PDR [1].
720 :param final_relative_width: Final lower bound transmit rate
721 cannot be more distant that this multiple of upper bound [1].
722 :param final_trial_duration: Trial duration for the final phase [s].
723 :param initial_trial_duration: Trial duration for the initial phase
724 and also for the first intermediate phase [s].
725 :param number_of_intermediate_phases: Number of intermediate phases
726 to perform before the final phase [1].
727 :param timeout: The search will fail itself when not finished
728 before this overall time [s].
729 :param doublings: How many doublings to do in external search step.
730 Default 1 is suitable for fairly stable tests,
731 less stable tests might get better overal duration with 2 or more.
732 :param traffic_directions: Traffic is bi- (2) or uni- (1) directional.
734 :type frame_size: str or int
735 :type traffic_profile: str
736 :type minimum_transmit_rate: float
737 :type maximum_transmit_rate: float
738 :type packet_loss_ratio: float
739 :type final_relative_width: float
740 :type final_trial_duration: float
741 :type initial_trial_duration: float
742 :type number_of_intermediate_phases: int
745 :type traffic_directions: int
746 :returns: Structure containing narrowed down NDR and PDR intervals
747 and their measurements.
749 :raises RuntimeError: If total duration is larger than timeout.
751 minimum_transmit_rate *= traffic_directions
752 maximum_transmit_rate *= traffic_directions
753 # we need instance of TrafficGenerator instantiated by Robot Framework
754 # to be able to use trex_stl-*()
755 tg_instance = BuiltIn().get_library_instance(
756 'resources.libraries.python.TrafficGenerator')
757 tg_instance.set_rate_provider_defaults(
758 frame_size, traffic_profile, traffic_directions=traffic_directions)
759 algorithm = MultipleLossRatioSearch(
760 measurer=tg_instance, final_trial_duration=final_trial_duration,
761 final_relative_width=final_relative_width,
762 number_of_intermediate_phases=number_of_intermediate_phases,
763 initial_trial_duration=initial_trial_duration, timeout=timeout,
765 result = algorithm.narrow_down_ndr_and_pdr(
766 minimum_transmit_rate, maximum_transmit_rate, packet_loss_ratio)
770 def perform_soak_search(
771 frame_size, traffic_profile, minimum_transmit_rate,
772 maximum_transmit_rate, plr_target=1e-7, tdpt=0.1,
773 initial_count=50, timeout=1800.0, trace_enabled=False,
774 traffic_directions=2):
775 """Setup initialized TG, perform soak search, return avg and stdev.
777 :param frame_size: Frame size identifier or value [B].
778 :param traffic_profile: Module name as a traffic profile identifier.
779 See resources/traffic_profiles/trex for implemented modules.
780 :param minimum_transmit_rate: Minimal uni-directional
781 target transmit rate [pps].
782 :param maximum_transmit_rate: Maximal uni-directional
783 target transmit rate [pps].
784 :param plr_target: Fraction of packets lost to achieve [1].
785 :param tdpt: Trial duration per trial.
786 The algorithm linearly increases trial duration with trial number,
787 this is the increment between succesive trials, in seconds.
788 :param initial_count: Offset to apply before the first trial.
789 For example initial_count=50 makes first trial to be 51*tdpt long.
790 This is needed because initial "search" phase of integrator
791 takes significant time even without any trial results.
792 :param timeout: The search will stop after this overall time [s].
793 :param traffic_directions: Traffic is bi- (2) or uni- (1) directional.
795 :type frame_size: str or int
796 :type traffic_profile: str
797 :type minimum_transmit_rate: float
798 :type maximum_transmit_rate: float
799 :type plr_target: float
800 :type initial_count: int
802 :type traffic_directions: int
803 :returns: Average and stdev of estimated aggregate rate giving PLR.
804 :rtype: 2-tuple of float
806 minimum_transmit_rate *= traffic_directions
807 maximum_transmit_rate *= traffic_directions
808 tg_instance = BuiltIn().get_library_instance(
809 'resources.libraries.python.TrafficGenerator')
810 tg_instance.set_rate_provider_defaults(
811 frame_size, traffic_profile, traffic_directions=traffic_directions)
812 algorithm = PLRsearch(
813 measurer=tg_instance, trial_duration_per_trial=tdpt,
814 packet_loss_ratio_target=plr_target,
815 trial_number_offset=initial_count, timeout=timeout,
816 trace_enabled=trace_enabled)
817 result = algorithm.search(minimum_transmit_rate, maximum_transmit_rate)