fix(stl_traffic): track both ports on unidir
[csit.git] / GPL / tools / trex / trex_stl_profile.py
index 38b7c26..abf79cd 100644 (file)
@@ -1,6 +1,6 @@
 #!/usr/bin/python3
 
-# Copyright (c) 2020 Cisco and/or its affiliates.
+# Copyright (c) 2022 Cisco and/or its affiliates.
 #
 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
 #
@@ -14,7 +14,8 @@
 #
 # 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.
+# 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,
@@ -33,9 +34,9 @@ import sys
 import time
 
 sys.path.insert(
-    0, u"/opt/trex-core-2.86/scripts/automation/trex_control_plane/interactive/"
+    0, u"/opt/trex-core-2.97/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):
@@ -79,6 +80,7 @@ def simple_burst(
         async_start=False,
         traffic_directions=2,
         force=False,
+        delay=0.0,
     ):
     """Send traffic and measure packet loss and latency.
 
@@ -107,6 +109,7 @@ def simple_burst(
     :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
@@ -117,6 +120,7 @@ def simple_burst(
     :type async_start: bool
     :type traffic_directions: int
     :type force: bool
+    :type delay: float
     """
     client = None
     total_rcvd = 0
@@ -151,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:
@@ -174,9 +178,8 @@ def simple_burst(
                 # Disable latency if NIC does not support requested stream type
                 print(u"##### FAILED to add latency streams #####")
                 latency = False
-        ports = [port_0]
-        if traffic_directions > 1:
-            ports.append(port_1)
+        # Even for unidir, both ports are needed to see both rx and tx.
+        ports = [port_0, port_1]
 
         # Clear the stats before injecting:
         client.clear_stats()
@@ -185,7 +188,7 @@ def simple_burst(
 
         # Choose rate and start traffic:
         client.start(
-            ports=ports,
+            ports=ports[:traffic_directions],
             mult=rate,
             duration=duration,
             force=force,
@@ -196,29 +199,29 @@ def simple_burst(
             # For async stop, we need to export the current snapshot.
             xsnap0 = client.ports[0].get_xstats().reference_stats
             print(f"Xstats snapshot 0: {xsnap0!r}")
-            if traffic_directions > 1:
-                xsnap1 = client.ports[1].get_xstats().reference_stats
-                print(f"Xstats snapshot 1: {xsnap1!r}")
+            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": ")))
 
             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"]
+            lost_b = stats[port_1][u"opackets"] - stats[port_0][u"ipackets"]
 
             # Stats index is not a port number, but "pgid".
             if latency:
@@ -226,22 +229,18 @@ def simple_burst(
                 lat_a = fmt_latency(
                     str(lat_obj[u"total_min"]), str(lat_obj[u"average"]),
                     str(lat_obj[u"total_max"]), str(lat_obj[u"hdrh"]))
+                # Do not bother with the other dir latency if unidir.
                 if traffic_directions > 1:
                     lat_obj = stats[u"latency"][1][u"latency"]
                     lat_b = fmt_latency(
                         str(lat_obj[u"total_min"]), str(lat_obj[u"average"]),
                         str(lat_obj[u"total_max"]), str(lat_obj[u"hdrh"]))
 
-            if traffic_directions > 1:
-                total_sent = stats[0][u"opackets"] + stats[1][u"opackets"]
-                total_rcvd = stats[0][u"ipackets"] + stats[1][u"ipackets"]
-            else:
-                total_sent = stats[port_0][u"opackets"]
-                total_rcvd = stats[port_1][u"ipackets"]
+            total_sent = stats[0][u"opackets"] + stats[1][u"opackets"]
+            total_rcvd = stats[0][u"ipackets"] + stats[1][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")
+            print(f"packets lost from {port_1} --> {port_0}: {lost_b} pkts")
 
     except STLError:
         print(u"T-Rex STL runtime error!", file=sys.stderr)
@@ -313,6 +312,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()
 
@@ -332,6 +335,7 @@ def main():
         async_start=args.async_start,
         traffic_directions=args.traffic_directions,
         force=args.force,
+        delay=args.delay,
     )