aboutsummaryrefslogtreecommitdiffstats
path: root/GPL
diff options
context:
space:
mode:
Diffstat (limited to 'GPL')
-rw-r--r--GPL/tools/trex/trex_astf_assert.py53
-rw-r--r--GPL/tools/trex/trex_astf_profile.py391
-rw-r--r--GPL/tools/trex/trex_astf_stop.py154
-rw-r--r--GPL/tools/trex/trex_stl_assert.py (renamed from GPL/tools/trex/trex_server_info.py)9
-rw-r--r--GPL/tools/trex/trex_stl_profile.py (renamed from GPL/tools/trex/trex_stateless_profile.py)32
-rw-r--r--GPL/tools/trex/trex_stl_stop.py (renamed from GPL/tools/trex/trex_stateless_stop.py)9
-rw-r--r--GPL/traffic_profiles/trex/profile_trex_astf_base_class.py129
-rw-r--r--GPL/traffic_profiles/trex/trex-astf-ethip4udp-1024h.py117
8 files changed, 870 insertions, 24 deletions
diff --git a/GPL/tools/trex/trex_astf_assert.py b/GPL/tools/trex/trex_astf_assert.py
new file mode 100644
index 0000000000..0e148f0435
--- /dev/null
+++ b/GPL/tools/trex/trex_astf_assert.py
@@ -0,0 +1,53 @@
+#!/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 script uses T-Rex advanced stateful (astf) API to drive T-Rex instance.
+
+Requirements:
+- T-Rex: https://github.com/cisco-system-traffic-generator/trex-core
+ - compiled and running T-Rex process (eg. ./t-rex-64 -i)
+ - trex.astf.api library
+- Script must be executed on a node with T-Rex instance.
+
+Functionality:
+1. Verify the API functionality and get server information.
+"""
+
+import sys
+
+sys.path.insert(
+ 0, u"/opt/trex-core-2.73/scripts/automation/trex_control_plane/interactive/"
+)
+from trex.astf.api import *
+
+
+def main():
+ """Check server info and quit."""
+ client = ASTFClient()
+ try:
+ # connect to server
+ client.connect()
+
+ # get server info
+ print(client.get_server_system_info())
+ except TRexError as ex_error:
+ print(ex_error, file=sys.stderr)
+ sys.exit(1)
+ finally:
+ client.disconnect()
+
+
+if __name__ == u"__main__":
+ main()
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()
diff --git a/GPL/tools/trex/trex_astf_stop.py b/GPL/tools/trex/trex_astf_stop.py
new file mode 100644
index 0000000000..be13e8ed42
--- /dev/null
+++ b/GPL/tools/trex/trex_astf_stop.py
@@ -0,0 +1,154 @@
+#!/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 script uses T-REX advanced stateful API to drive t-rex instance.
+
+Requirements:
+- T-REX: https://github.com/cisco-system-traffic-generator/trex-core
+ - compiled and running T-REX process (eg. ./t-rex-64 -i)
+ - trex.astf.api library
+- Script must be executed on a node with T-REX instance
+
+Functionality:
+1. Stop any running traffic
+2. Optionally restore reference counter values.
+3. Return conter differences.
+"""
+
+import argparse
+import json
+import sys
+
+from collections import OrderedDict # Needed to parse xstats representation.
+
+sys.path.insert(
+ 0, u"/opt/trex-core-2.73/scripts/automation/trex_control_plane/interactive/"
+)
+from trex.astf.api import *
+
+
+def main():
+ """Stop traffic if any is running. Report xstats."""
+ parser = argparse.ArgumentParser()
+ parser.add_argument(
+ u"--xstat0", type=str, default=u"",
+ help=u"Reference xstat object if any."
+ )
+ parser.add_argument(
+ u"--xstat1", type=str, default=u"",
+ help=u"Reference xstat object if any."
+ )
+ args = parser.parse_args()
+
+ client = ASTFClient()
+ try:
+ # connect to server
+ client.connect()
+
+ client.acquire(force=True)
+ client.stop()
+
+ # Read the stats after the test,
+ # we need to update values before the last trial started.
+ if args.xstat0:
+ snapshot = eval(args.xstat0)
+ client.ports[0].get_xstats().reference_stats = snapshot
+ if args.xstat1:
+ snapshot = eval(args.xstat1)
+ client.ports[1].get_xstats().reference_stats = snapshot
+ # Now we can call the official method to get differences.
+ xstats0 = client.get_xstats(0)
+ xstats1 = client.get_xstats(1)
+
+ # If TRexError happens, let the script fail with stack trace.
+ finally:
+ client.clear_profile()
+ client.disconnect()
+
+ # TODO: check xstats format
+ print(u"##### statistics port 0 #####")
+ print(json.dumps(xstats0, indent=4, separators=(u",", u": ")))
+ print(u"##### statistics port 1 #####")
+ print(json.dumps(xstats1, indent=4, separators=(u",", u": ")))
+
+ tx_0, rx_0 = xstats0[u"tx_good_packets"], xstats0[u"rx_good_packets"]
+ tx_1, rx_1 = xstats1[u"tx_good_packets"], xstats1[u"rx_good_packets"]
+ lost_a, lost_b = tx_0 - rx_1, tx_1 - rx_0
+
+ client_stats = xstats0[u"traffic"][u"client"]
+ server_stats = xstats1[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
+ # 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)
+ # 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}, "
+
+ print(f"packets lost from 0 --> 1: {lost_a} pkts")
+ print(f"packets lost from 1 --> 0: {lost_b} pkts")
+
+ total_rcvd, total_sent = rx_0 + rx_1, tx_0 + tx_1
+ total_lost = total_sent - total_rcvd
+ # TODO: Add latency.
+ print(
+ f"cps='unknown', total_received={total_rcvd}, total_sent={total_sent}, "
+ f"frame_loss={total_lost}, "
+ f"latency_stream_0(usec)=-1/-1/-1, latency_stream_1(usec)=-1/-1/-1, "
+ u"latency_hist_stream_0={}, latency_hist_stream_1={}, "
+ f"{l7_data}"
+ )
+
+
+if __name__ == u"__main__":
+ main()
diff --git a/GPL/tools/trex/trex_server_info.py b/GPL/tools/trex/trex_stl_assert.py
index 8423801285..835d009b26 100644
--- a/GPL/tools/trex/trex_server_info.py
+++ b/GPL/tools/trex/trex_stl_assert.py
@@ -13,17 +13,16 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""This script uses T-REX stateless API to drive t-rex instance.
+"""This script uses T-Rex stateless API to drive T-Rex instance.
Requirements:
- T-REX: https://github.com/cisco-system-traffic-generator/trex-core
- - compiled and running T-REX process (eg. ./t-rex-64 -i)
+ - compiled and running T-Rex process (eg. ./t-rex-64 -i)
- trex.stl.api library
-- Script must be executed on a node with T-REX instance
+- Script must be executed on a node with T-Rex instance.
Functionality:
-1. Verify the API functionality and get server information
-
+1. Verify the API functionality and get server information.
"""
import sys
diff --git a/GPL/tools/trex/trex_stateless_profile.py b/GPL/tools/trex/trex_stl_profile.py
index 7d83936266..64b8342e57 100644
--- a/GPL/tools/trex/trex_stateless_profile.py
+++ b/GPL/tools/trex/trex_stl_profile.py
@@ -120,9 +120,9 @@ def simple_burst(
rate=rate
)
streams = profile.get_streams()
- except STLError as err:
- print(f"Error while loading profile '{profile_file}' {err!r}")
- sys.exit(1)
+ except STLError:
+ print(f"Error while loading profile '{profile_file}'!")
+ raise
try:
# Create the client:
@@ -168,8 +168,9 @@ def simple_burst(
client.clear_stats()
# Choose rate and start traffic:
- client.start(ports=ports, mult=rate, duration=warmup_time,
- force=force)
+ client.start(
+ ports=ports, mult=rate, duration=warmup_time, force=force
+ )
# Block until done:
time_start = time.monotonic()
@@ -258,9 +259,9 @@ def simple_burst(
if traffic_directions > 1:
print(f"packets lost from {port_1} --> {port_0}: {lost_b} pkts")
- except STLError as ex_error:
- print(ex_error, file=sys.stderr)
- sys.exit(1)
+ except STLError:
+ print(u"T-Rex STL runtime error!", file=sys.stderr)
+ raise
finally:
if async_start:
@@ -270,12 +271,13 @@ def simple_burst(
if client:
client.disconnect()
print(
- f"rate={rate!r}, totalReceived={total_rcvd}, "
- f"totalSent={total_sent}, frameLoss={lost_a + lost_b}, "
- f"targetDuration={duration!r}, "
- f"approximatedDuration={approximated_duration!r}, "
- f"approximatedRate={approximated_rate}, "
- f"latencyStream0(usec)={lat_a}, latencyStream1(usec)={lat_b}, "
+ 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}, "
)
@@ -300,7 +302,7 @@ def main():
)
parser.add_argument(
u"-r", u"--rate", required=True,
- help=u"Traffic rate with included units (%, pps)."
+ help=u"Traffic rate with included units (pps)."
)
parser.add_argument(
u"-w", u"--warmup_time", type=float, default=5.0,
diff --git a/GPL/tools/trex/trex_stateless_stop.py b/GPL/tools/trex/trex_stl_stop.py
index 5e8721d28c..28a9de9421 100644
--- a/GPL/tools/trex/trex_stateless_stop.py
+++ b/GPL/tools/trex/trex_stl_stop.py
@@ -93,10 +93,11 @@ def main():
total_lost = total_sent - total_rcvd
# TODO: Add latency.
print(
- f"rate='unknown', totalReceived={total_rcvd}, totalSent={total_sent}, "
- f"frameLoss={total_lost}, targetDuration='manual', "
- f"approximatedDuration='manual', approximatedRate='unknown', "
- f"latencyStream0(usec)=-1/-1/-1, latencyStream1(usec)=-1/-1/-1"
+ f"rate='unknown', total_received={total_rcvd}, "
+ f"total_sent={total_sent}, frame_loss={total_lost}, "
+ f"target_duration='manual', approximated_duration='manual', "
+ f"approximated_rate='unknown', "
+ f"latency_stream_0(usec)=-1/-1/-1, latency_stream_1(usec)=-1/-1/-1"
)
diff --git a/GPL/traffic_profiles/trex/profile_trex_astf_base_class.py b/GPL/traffic_profiles/trex/profile_trex_astf_base_class.py
new file mode 100644
index 0000000000..ed28ccbb78
--- /dev/null
+++ b/GPL/traffic_profiles/trex/profile_trex_astf_base_class.py
@@ -0,0 +1,129 @@
+# 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.
+
+"""Base class for profiles for T-rex advanced stateful (astf) traffic generator.
+"""
+
+from random import choices
+from string import ascii_letters
+
+from trex.astf.api import *
+
+
+class TrafficProfileBaseClass:
+ """Base class for profiles for T-rex astf traffic generator."""
+
+ STREAM_TABLE = {
+ u"IMIX_v4": [
+ {u"size": 60, u"pps": 28, u"isg": 0},
+ {u"size": 590, u"pps": 20, u"isg": 0.1},
+ {u"size": 1514, u"pps": 4, u"isg": 0.2}
+ ],
+ 'IMIX_v4_1': [
+ {u"size": 64, u"pps": 28, u"isg": 0},
+ {u"size": 570, u"pps": 16, u"isg": 0.1},
+ {u"size": 1518, u"pps": 4, u"isg": 0.2}
+ ]
+ }
+
+ def __init__(self):
+ # Default values of required parameters; can be overwritten in
+ # "get_profile" method.
+ self.framesize = 64
+ self._pcap_dir = u""
+
+ # If needed, add your own parameters.
+
+ @property
+ def pcap_dir(self):
+ """Pcap file directory.
+
+ If needed, implement your own algorithm.
+
+ :returns: Pcap file directory.
+ :rtype: str
+ """
+ return self._pcap_dir
+
+ def _gen_padding(self, current_length, required_length=0):
+ """Generate padding.
+
+ If needed, implement your own algorithm.
+
+ :param current_length: Current length of the packet.
+ :param required_length: Required length of the packet. If set to 0 then
+ self.framesize value is used.
+ :type current_length: int
+ :type required_length: int
+ :returns: The generated padding.
+ :rtype: str
+ """
+ # TODO: Add support for IMIX frame size;
+ # use random.randrange(0, len(self.STREAM_TABLE[self.framesize])) ?
+ if not required_length:
+ required_length = self.framesize
+
+ return str(choices(ascii_letters, k=required_length - current_length))
+
+ def define_profile(self):
+ """Define profile to be used by T-Rex astf traffic generator.
+
+ This method MUST return:
+
+ return ip_gen, templates, cap_list
+
+ templates or cap_list CAN be None.
+
+ :returns: IP generator and profile templates or list of pcap files for
+ traffic generator.
+ :rtype: tuple
+ """
+ raise NotImplementedError
+
+ def create_profile(self):
+ """Create traffic profile.
+
+ Implement your own traffic profiles.
+
+ :returns: Traffic profile.
+ :rtype: trex.astf.trex_astf_profile.ASTFProfile
+ """
+ ip_gen, templates, cap_list = self.define_profile()
+
+ # In most cases you will not have to change the code below:
+
+ # profile
+ profile = ASTFProfile(
+ default_ip_gen=ip_gen,
+ templates=templates,
+ cap_list=cap_list
+ )
+
+ return profile
+
+ def get_profile(self, **kwargs):
+ """Get traffic profile created by "create_profile" method.
+
+ If needed, add your own parameters.
+
+ :param kwargs: Key-value pairs used by "create_profile" method while
+ creating the profile.
+ :returns: Traffic profile.
+ :rtype: trex.astf.trex_astf_profile.ASTFProfile
+ """
+ self.framesize = kwargs[u"framesize"]
+ self._pcap_dir = kwargs.get(
+ u"pcap_dir",u"/opt/trex-core-2.73/scripts/avl"
+ )
+
+ return self.create_profile()
diff --git a/GPL/traffic_profiles/trex/trex-astf-ethip4udp-1024h.py b/GPL/traffic_profiles/trex/trex-astf-ethip4udp-1024h.py
new file mode 100644
index 0000000000..a010fe1613
--- /dev/null
+++ b/GPL/traffic_profiles/trex/trex-astf-ethip4udp-1024h.py
@@ -0,0 +1,117 @@
+# 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.
+
+"""Traffic profile for T-rex advanced stateful (astf) traffic generator.
+
+Traffic profile:
+ - Two streams sent in directions 0 --> 1 (client -> server, requests) and
+ 1 --> 0 (server -> client, responses) at the same time.
+ - Packet: ETH / IP / UDP
+ - Direction 0 --> 1:
+ - Source IP address range: 192.168.0.0 - 192.168.3.255
+ - Destination IP address range: 20.0.0.0 - 20.0.3.255
+ - Direction 1 --> 0:
+ - Source IP address range: destination IP address from packet received
+ on port 1
+ - Destination IP address range: source IP address from packet received
+ on port 1
+"""
+
+from trex.astf.api import *
+
+from profile_trex_astf_base_class import TrafficProfileBaseClass
+
+
+class TrafficProfile(TrafficProfileBaseClass):
+ """Traffic profile."""
+
+ def __init__(self):
+ """Initialization and setting of profile parameters."""
+
+ super(TrafficProfileBaseClass, self).__init__()
+
+ # IPs used in packet headers.
+ self.p1_src_start_ip = u"192.168.0.0"
+ self.p1_src_end_ip = u"192.168.3.255"
+ self.p1_dst_start_ip = u"20.0.0.0"
+ self.p1_dst_end_ip = u"20.0.3.255"
+
+ # UDP messages
+ self.udp_req = u"GET"
+ self.udp_res = u"ACK"
+
+ # Headers length
+ self.headers_size = 42 # 14B l2 + 20B ipv4 + 8B udp
+
+ def define_profile(self):
+ """Define profile to be used by advanced stateful traffic generator.
+
+ This method MUST return:
+ return ip_gen, templates, None
+
+ :returns: IP generator and profile templates ASTFProfile().
+ :rtype: tuple
+ """
+ self.udp_req += self._gen_padding(self.headers_size + len(self.udp_req))
+ self.udp_res += self._gen_padding(self.headers_size + len(self.udp_res))
+
+ # client commands
+ prog_c = ASTFProgram(stream=False)
+ prog_c.send_msg(self.udp_req) # size and fill not supported in v2.73
+ prog_c.recv_msg(1)
+
+ # server commands
+ prog_s = ASTFProgram(stream=False)
+ prog_s.recv_msg(1)
+ prog_s.send_msg(self.udp_res)
+
+ # ip generators
+ ip_gen_c = ASTFIPGenDist(
+ ip_range=[self.p1_src_start_ip, self.p1_src_end_ip],
+ distribution=u"seq"
+ )
+ ip_gen_s = ASTFIPGenDist(
+ ip_range=[self.p1_dst_start_ip, self.p1_dst_end_ip],
+ distribution=u"seq"
+ )
+ ip_gen = ASTFIPGen(
+ glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
+ dist_client=ip_gen_c,
+ dist_server=ip_gen_s
+ )
+
+ # server association
+ s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
+
+ # template
+ temp_c = ASTFTCPClientTemplate(
+ program=prog_c,
+ ip_gen=ip_gen,
+ limit=64512, # TODO: set via input parameter ?
+ port=8080
+ )
+ temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
+ template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
+
+ return ip_gen, template, None
+
+
+def register():
+ """Register this traffic profile to T-Rex.
+
+ Do not change this function.
+
+ :return: Traffic Profiles.
+ :rtype: Object
+ """
+ return TrafficProfile()