FIX: Pylint reduce
[csit.git] / GPL / tools / trex / trex_stl_profile.py
index ac09b8d..cef9858 100644 (file)
@@ -1,11 +1,21 @@
 #!/usr/bin/python3
 
-# 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:
+# Copyright (c) 2021 Cisco and/or its affiliates.
+#
+# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
+#
+# Licensed under the Apache License 2.0 or
+# GNU General Public License v2.0 or later;  you may not use this file
+# except in compliance with one of these Licenses. You
+# may obtain a copy of the Licenses at:
 #
 #     http://www.apache.org/licenses/LICENSE-2.0
+#     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
+#
+# Note: If this file is linked with Scapy, which is GPLv2+, your use of it
+# must be under GPLv2+.  If at any point in the future it is no longer linked
+# with Scapy (or other GPLv2+ licensed software), you are free to choose
+# Apache 2.
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
@@ -24,9 +34,9 @@ import sys
 import time
 
 sys.path.insert(
-    0, u"/opt/trex-core-2.82/scripts/automation/trex_control_plane/interactive/"
+    0, u"/opt/trex-core-2.88/scripts/automation/trex_control_plane/interactive/"
 )
-from trex.stl.api import *
+from trex.stl.api import STLClient, STLProfile, STLError
 
 
 def fmt_latency(lat_min, lat_avg, lat_max, hdrh):
@@ -60,8 +70,18 @@ def fmt_latency(lat_min, lat_avg, lat_max, hdrh):
 
 
 def simple_burst(
-        profile_file, duration, framesize, rate, warmup_time, port_0, port_1,
-        latency, async_start=False, traffic_directions=2, force=False):
+        profile_file,
+        duration,
+        framesize,
+        rate,
+        port_0,
+        port_1,
+        latency,
+        async_start=False,
+        traffic_directions=2,
+        force=False,
+        delay=0.0,
+    ):
     """Send traffic and measure packet loss and latency.
 
     Procedure:
@@ -83,30 +103,29 @@ def simple_burst(
     :param framesize: Frame size.
     :param duration: Duration of traffic run in seconds (-1=infinite).
     :param rate: Traffic rate [percentage, pps, bps].
-    :param warmup_time: Traffic warm-up time in seconds, 0 = disable.
     :param port_0: Port 0 on the traffic generator.
     :param port_1: Port 1 on the traffic generator.
     :param latency: With latency stats.
     :param async_start: Start the traffic and exit.
     :param traffic_directions: Bidirectional (2) or unidirectional (1) traffic.
     :param force: Force start regardless of ports state.
+    :param delay: Sleep overhead [s].
     :type profile_file: str
     :type framesize: int or str
     :type duration: float
     :type rate: str
-    :type warmup_time: float
     :type port_0: int
     :type port_1: int
     :type latency: bool
     :type async_start: bool
     :type traffic_directions: int
     :type force: bool
+    :type delay: float
     """
     client = None
     total_rcvd = 0
     total_sent = 0
-    approximated_duration = 0
-    approximated_rate = 0
+    approximated_duration = 0.0
     lost_a = 0
     lost_b = 0
     lat_a = u"-1/-1/-1/"
@@ -136,7 +155,7 @@ def simple_burst(
         if u"macsrc" in profile_file:
             client.set_port_attr(ports=[port_0, port_1], promiscuous=True)
         if isinstance(framesize, int):
-            last_stream_a = int((len(streams) - 2 ) / 2)
+            last_stream_a = int((len(streams) - 2) / 2)
             last_stream_b = (last_stream_a * 2)
             client.add_streams(streams[0:last_stream_a], ports=[port_0])
             if traffic_directions > 1:
@@ -162,40 +181,6 @@ def simple_burst(
         ports = [port_0]
         if traffic_directions > 1:
             ports.append(port_1)
-        # Warm-up phase:
-        if warmup_time > 0:
-            # Clear the stats before injecting:
-            client.clear_stats()
-
-            # Choose rate and start traffic:
-            client.start(
-                ports=ports, mult=rate, duration=warmup_time, force=force,
-                core_mask=STLClient.CORE_MASK_PIN
-            )
-
-            # Block until done:
-            time_start = time.monotonic()
-            client.wait_on_traffic(ports=ports, timeout=warmup_time+30)
-            time_stop = time.monotonic()
-            approximated_duration = time_stop - time_start
-
-            if client.get_warnings():
-                for warning in client.get_warnings():
-                    print(warning)
-
-            # Read the stats after the test:
-            stats = client.get_stats()
-
-            print(u"##### Warmup statistics #####")
-            print(json.dumps(stats, indent=4, separators=(u",", u": ")))
-
-            lost_a = stats[port_0][u"opackets"] - stats[port_1][u"ipackets"]
-            if traffic_directions > 1:
-                lost_b = stats[port_1][u"opackets"] - stats[port_0][u"ipackets"]
-
-            print(f"\npackets lost from {port_0} --> {port_1}: {lost_a} pkts")
-            if traffic_directions > 1:
-                print(f"packets lost from {port_1} --> {port_0}: {lost_b} pkts")
 
         # Clear the stats before injecting:
         client.clear_stats()
@@ -204,8 +189,11 @@ def simple_burst(
 
         # Choose rate and start traffic:
         client.start(
-            ports=ports, mult=rate, duration=duration, force=force,
-            core_mask=STLClient.CORE_MASK_PIN
+            ports=ports,
+            mult=rate,
+            duration=duration,
+            force=force,
+            core_mask=STLClient.CORE_MASK_PIN,
         )
 
         if async_start:
@@ -216,18 +204,20 @@ def simple_burst(
                 xsnap1 = client.ports[1].get_xstats().reference_stats
                 print(f"Xstats snapshot 1: {xsnap1!r}")
         else:
-            # Block until done:
             time_start = time.monotonic()
-            client.wait_on_traffic(ports=ports, timeout=duration+30)
+            # wait_on_traffic fails if duration stretches by 30 seconds or more.
+            # TRex has some overhead, wait some more.
+            time.sleep(duration + delay)
+            client.stop()
             time_stop = time.monotonic()
-            approximated_duration = time_stop - time_start
-
+            approximated_duration = time_stop - time_start - delay
+            # Read the stats after the traffic stopped (or time up).
+            stats = client.get_stats()
             if client.get_warnings():
                 for warning in client.get_warnings():
                     print(warning)
-
-            # Read the stats after the test
-            stats = client.get_stats()
+            # Now finish the complete reset.
+            client.reset()
 
             print(u"##### Statistics #####")
             print(json.dumps(stats, indent=4, separators=(u",", u": ")))
@@ -254,10 +244,6 @@ def simple_burst(
             else:
                 total_sent = stats[port_0][u"opackets"]
                 total_rcvd = stats[port_1][u"ipackets"]
-            try:
-                approximated_rate = total_sent / approximated_duration
-            except ZeroDivisionError:
-                pass
 
             print(f"\npackets lost from {port_0} --> {port_1}: {lost_a} pkts")
             if traffic_directions > 1:
@@ -275,13 +261,14 @@ def simple_burst(
             if client:
                 client.disconnect()
             print(
-                f"rate={rate!r}, total_received={total_rcvd}, "
-                f"total_sent={total_sent}, frame_loss={lost_a + lost_b}, "
-                f"target_duration={duration!r}, "
-                f"approximated_duration={approximated_duration!r}, "
-                f"approximated_rate={approximated_rate}, "
-                f"latency_stream_0(usec)={lat_a}, "
-                f"latency_stream_1(usec)={lat_b}, "
+                f"rate={rate!r}; "
+                f"total_received={total_rcvd}; "
+                f"total_sent={total_sent}; "
+                f"frame_loss={lost_a + lost_b}; "
+                f"target_duration={duration!r}; "
+                f"approximated_duration={approximated_duration!r}; "
+                f"latency_stream_0(usec)={lat_a}; "
+                f"latency_stream_1(usec)={lat_b}; "
             )
 
 
@@ -308,10 +295,6 @@ def main():
         u"-r", u"--rate", required=True,
         help=u"Traffic rate with included units (pps)."
     )
-    parser.add_argument(
-        u"-w", u"--warmup_time", type=float, default=5.0,
-        help=u"Traffic warm-up time in seconds, 0 = disable."
-    )
     parser.add_argument(
         u"--port_0", required=True, type=int,
         help=u"Port 0 on the traffic generator."
@@ -336,6 +319,10 @@ def main():
         u"--force", action=u"store_true", default=False,
         help=u"Force start regardless of ports state."
     )
+    parser.add_argument(
+        u"--delay", required=True, type=float, default=0.0,
+        help=u"Delay assumed for traffic, sleep time is increased by this [s]."
+    )
 
     args = parser.parse_args()
 
@@ -345,10 +332,17 @@ def main():
         framesize = args.frame_size
 
     simple_burst(
-        profile_file=args.profile, duration=args.duration, framesize=framesize,
-        rate=args.rate, warmup_time=args.warmup_time, port_0=args.port_0,
-        port_1=args.port_1, latency=args.latency, async_start=args.async_start,
-        traffic_directions=args.traffic_directions, force=args.force
+        profile_file=args.profile,
+        duration=args.duration,
+        framesize=framesize,
+        rate=args.rate,
+        port_0=args.port_0,
+        port_1=args.port_1,
+        latency=args.latency,
+        async_start=args.async_start,
+        traffic_directions=args.traffic_directions,
+        force=args.force,
+        delay=args.delay,
     )