T-Rex: Add advanced stateful mode

- provide base routines to run T-Rex in advanced stateful mode

Change-Id: Ib0dc5f2919c370753335f6446860683dc4b12d93
Signed-off-by: Jan Gelety <jgelety@cisco.com>

1 files changed, 391 insertions, 0 deletions

diff --git a/GPL/tools/trex/trex_astf_profile.py b/GPL/tools/trex/trex_astf_profile.py
new file mode 100644
index 0000000000..ed0b8fc0b3
--- /dev/null
+++ b/GPL/tools/trex/trex_astf_profile.py
@@ -0,0 +1,391 @@
+#!/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:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""This module gets T-Rex advanced stateful (astf) traffic profile together
+with other parameters, reads the profile and sends the traffic. At the end, it
+measures the packet loss and latency.
+"""
+
+import argparse
+import json
+import sys
+import time
+
+sys.path.insert(
+    0, u"/opt/trex-core-2.73/scripts/automation/trex_control_plane/interactive/"
+)
+from trex.astf.api import *
+
+
+def fmt_latency(lat_min, lat_avg, lat_max, hdrh):
+    """Return formatted, rounded latency.
+
+    :param lat_min: Min latency
+    :param lat_avg: Average latency
+    :param lat_max: Max latency
+    :param hdrh: Base64 encoded compressed HDRHistogram object.
+    :type lat_min: str
+    :type lat_avg: str
+    :type lat_max: str
+    :type hdrh: str
+    :return: Formatted and rounded output (hdrh unchanged) "min/avg/max/hdrh".
+    :rtype: str
+    """
+    try:
+        t_min = int(round(float(lat_min)))
+    except ValueError:
+        t_min = int(-1)
+    try:
+        t_avg = int(round(float(lat_avg)))
+    except ValueError:
+        t_avg = int(-1)
+    try:
+        t_max = int(round(float(lat_max)))
+    except ValueError:
+        t_max = int(-1)
+
+    return u"/".join(str(tmp) for tmp in (t_min, t_avg, t_max, hdrh))
+
+
+def simple_burst(
+        profile_file, duration, framesize, mult, warmup_time, port_0, port_1,
+        latency, async_start=False, traffic_directions=2):
+    """Send traffic and measure packet loss and latency.
+
+    Procedure:
+     - reads the given traffic profile with streams,
+     - connects to the T-rex astf client,
+     - resets the ports,
+     - removes all existing streams,
+     - adds streams from the traffic profile to the ports,
+     - if the warm-up time is more than 0, sends the warm-up traffic, reads the
+       statistics,
+     - clears the statistics from the client,
+     - starts the traffic,
+     - waits for the defined time (or runs forever if async mode is defined),
+     - stops the traffic,
+     - reads and displays the statistics and
+     - disconnects from the client.
+
+    :param profile_file: A python module with T-rex traffic profile.
+    :param duration: Duration of traffic run in seconds (-1=infinite).
+    :param framesize: Frame size.
+    :param mult: Multiplier of profile CPS.
+    :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.
+    :type profile_file: str
+    :type duration: float
+    :type framesize: int or str
+    :type mult: int
+    :type warmup_time: float
+    :type port_0: int
+    :type port_1: int
+    :type latency: bool
+    :type async_start: bool
+    :type traffic_directions: int
+    """
+    client = None
+    total_rcvd = 0
+    total_sent = 0
+    lost_a = 0
+    lost_b = 0
+    lat_a = u"-1/-1/-1/"
+    lat_b = u"-1/-1/-1/"
+    lat_a_hist = u""
+    lat_b_hist = u""
+    l7_data = u""
+    stats = dict()
+    stats_sampling = 1.0
+    approximated_duration = 0
+
+    # Read the profile.
+    try:
+        # TODO: key-values pairs to the profile file
+        #  - ips ?
+        print(f"### Profile file:\n{profile_file}")
+        profile = ASTFProfile.load(profile_file, framesize=framesize)
+    except TRexError:
+        print(f"Error while loading profile '{profile_file}'!")
+        raise
+
+    try:
+        # Create the client.
+        client = ASTFClient()
+        # Connect to server
+        client.connect()
+        # Acquire ports, stop the traffic, remove loaded traffic and clear
+        # stats.
+        client.reset()
+        # Load the profile.
+        client.load_profile(profile)
+
+        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 CPS and start traffic.
+            client.start(mult=mult, duration=warmup_time)
+            time_start = time.monotonic()
+
+            # Read the stats after the warmup duration (no sampling needed).
+            time.sleep(warmup_time)
+            stats[time.monotonic()-time_start] = client.get_stats()
+
+            if client.get_warnings():
+                for warning in client.get_warnings():
+                    print(warning)
+
+            client.reset()
+
+            print(u"##### Warmup Statistics #####")
+            print(json.dumps(stats, indent=4, separators=(u",", u": ")))
+
+            # TODO: check stats format
+            stats = stats[sorted(stats.keys())[-1]]
+            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"packets 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.
+        lost_a = 0
+        lost_b = 0
+        stats = dict()
+
+        # Choose CPS and start traffic.
+        client.start(
+            mult=mult, duration=duration, nc=True,
+            latency_pps=mult if latency else 0, client_mask=2**len(ports)-1
+        )
+        time_start = time.monotonic()
+
+        if async_start:
+            # For async stop, we need to export the current snapshot.
+            xsnap0 = client.ports[port_0].get_xstats().reference_stats
+            print(f"Xstats snapshot 0: {xsnap0!r}")
+            if traffic_directions > 1:
+                xsnap1 = client.ports[port_1].get_xstats().reference_stats
+                print(f"Xstats snapshot 1: {xsnap1!r}")
+        else:
+            # Do not block until done.
+            while client.is_traffic_active(ports=ports):
+                time.sleep(
+                    stats_sampling if stats_sampling < duration else duration
+                )
+                # Sample the stats.
+                stats[time.monotonic()-time_start] = client.get_stats(
+                    ports=ports
+                )
+            else:
+                # Read the stats after the test
+                stats[time.monotonic()-time_start] = client.get_stats(
+                    ports=ports
+                )
+
+            if client.get_warnings():
+                for warning in client.get_warnings():
+                    print(warning)
+
+            client.reset()
+
+            print(u"##### Statistics #####")
+            print(json.dumps(stats, indent=4, separators=(u",", u": ")))
+
+            approximated_duration = list(sorted(stats.keys()))[-1]
+            stats = stats[sorted(stats.keys())[-1]]
+            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"]
+
+            # TODO: Latency measurement not used at this phase. This part will
+            #  be aligned in another commit.
+            # Stats index is not a port number, but "pgid".
+            if latency:
+                lat_obj = stats[u"latency"][0][u"hist"]
+                # TODO: Latency histogram is dictionary in astf mode,
+                #  needs additional processing
+                lat_a = fmt_latency(
+                    str(lat_obj[u"min_usec"]), str(lat_obj[u"s_avg"]),
+                    str(lat_obj[u"max_usec"]), u"-")
+                lat_a_hist = str(lat_obj[u"histogram"])
+                if traffic_directions > 1:
+                    lat_obj = stats[u"latency"][1][u"hist"]
+                    lat_b = fmt_latency(
+                        str(lat_obj[u"min_usec"]), str(lat_obj[u"s_avg"]),
+                        str(lat_obj[u"max_usec"]), u"-")
+                    lat_b_hist = str(lat_obj[u"histogram"])
+
+            if traffic_directions > 1:
+                total_sent = \
+                    stats[port_0][u"opackets"] + stats[port_1][u"opackets"]
+                total_rcvd = \
+                    stats[port_0][u"ipackets"] + stats[port_1][u"ipackets"]
+                client_stats = stats[u"traffic"][u"client"]
+                server_stats = stats[u"traffic"][u"server"]
+                # Active and established flows UDP/TCP
+                # Client
+                c_act_flows = client_stats[u"m_active_flows"]
+                c_est_flows = client_stats[u"m_est_flows"]
+                l7_data = f"client_active_flows={c_act_flows}, "
+                l7_data += f"client_established_flows={c_est_flows}, "
+                # Server
+                s_act_flows = server_stats[u"m_active_flows"]
+                s_est_flows = server_stats[u"m_est_flows"]
+                l7_data += f"server_active_flows={s_act_flows}, "
+                l7_data += f"server_established_flows={s_est_flows}, "
+                # Some zero counters are not sent
+                if u"udp" in profile_file:
+                    # Client
+                    # Established connections
+                    c_udp_connects = client_stats.get(u"udps_connects", 0)
+                    l7_data += f"client_udp_connects={c_udp_connects}, "
+                    # Closed connections
+                    c_udp_closed = client_stats.get(u"udps_closed", 0)
+                    l7_data += f"client_udp_closed={c_udp_closed}, "
+                    # Server
+                    # Accepted connections
+                    s_udp_accepts = server_stats.get(u"udps_accepts", 0)
+                    l7_data += f"server_udp_accepts={s_udp_accepts}, "
+                    # Closed connections
+                    s_udp_closed = server_stats.get(u"udps_closed", 0)
+                    l7_data += f"server_udp_closed={s_udp_closed}, "
+                elif u"tcp" in profile_file:
+                    # Client
+                    # Initiated connections
+                    c_tcp_connatt = client_stats.get(u"tcps_connattempt", 0)
+                    l7_data += f"client_tcp_connect_inits={c_tcp_connatt}, "
+                    # Established connections
+                    c_tcp_connects = client_stats.get(u"tcps_connects", 0)
+                    l7_data += f"client_tcp_connects={c_tcp_connects}, "
+                    # Closed connections
+                    c_tcp_closed = client_stats.get(u"tcps_closed", 0)
+                    l7_data += f"client_tcp_closed={c_tcp_closed}, "
+                    # Server
+                    # Accepted connections
+                    s_tcp_accepts = server_stats.get(u"tcps_accepts", 0)
+                    l7_data += f"server_tcp_accepts={s_tcp_accepts}, "
+                    # Established connections
+                    s_tcp_connects = server_stats.get(u"tcps_connects", 0)
+                    l7_data += f"server_tcp_connects={s_tcp_connects}, "
+                    # Closed connections
+                    s_tcp_closed = server_stats.get(u"tcps_closed", 0)
+                    l7_data += f"server_tcp_closed={s_tcp_closed}, "
+            else:
+                total_sent = stats[port_0][u"opackets"]
+                total_rcvd = stats[port_1][u"ipackets"]
+
+            print(f"packets 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")
+
+    except TRexError:
+        print(u"T-Rex ASTF runtime error!", file=sys.stderr)
+        raise
+
+    finally:
+        if client:
+            if async_start:
+                client.disconnect(stop_traffic=False, release_ports=True)
+            else:
+                client.clear_profile()
+                client.disconnect()
+                print(
+                    f"cps={mult!r}, total_received={total_rcvd}, "
+                    f"total_sent={total_sent}, frame_loss={lost_a + lost_b}, "
+                    f"approximated_duration={approximated_duration}, "
+                    f"latency_stream_0(usec)={lat_a}, "
+                    f"latency_stream_1(usec)={lat_b}, "
+                    f"latency_hist_stream_0={lat_a_hist}, "
+                    f"latency_hist_stream_1={lat_b_hist}, "
+                    f"{l7_data}"
+                )
+
+
+def main():
+    """Main function for the traffic generator using T-rex.
+
+    It verifies the given command line arguments and runs "simple_burst"
+    function.
+    """
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        u"-p", u"--profile", required=True, type=str,
+        help=u"Python traffic profile."
+    )
+    parser.add_argument(
+        u"-d", u"--duration", required=True, type=float,
+        help=u"Duration of traffic run."
+    )
+    parser.add_argument(
+        u"-s", u"--frame_size", required=True,
+        help=u"Size of a Frame without padding and IPG."
+    )
+    parser.add_argument(
+        u"-m", u"--mult", required=True, type=int,
+        help=u"Multiplier of profile CPS."
+    )
+    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."
+    )
+    parser.add_argument(
+        u"--port_1", required=True, type=int,
+        help=u"Port 1 on the traffic generator."
+    )
+    parser.add_argument(
+        u"--async_start", action=u"store_true", default=False,
+        help=u"Non-blocking call of the script."
+    )
+    parser.add_argument(
+        u"--latency", action=u"store_true", default=False,
+        help=u"Add latency stream."
+    )
+    parser.add_argument(
+        u"--traffic_directions", type=int, default=2,
+        help=u"Send bi- (2) or uni- (1) directional traffic."
+    )
+
+    args = parser.parse_args()
+
+    try:
+        framesize = int(args.frame_size)
+    except ValueError:
+        framesize = args.frame_size
+
+    simple_burst(
+        profile_file=args.profile, duration=args.duration, framesize=framesize,
+        mult=args.mult, 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
+    )
+
+
+if __name__ == u"__main__":
+    main()