3 # Copyright (c) 2017 Cisco and/or its affiliates.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 """This module gets a traffic profile together with other parameters, reads
17 the profile and sends the traffic. At the end, it measures the packet loss and
25 sys.path.insert(0, "/opt/trex-core-2.35/scripts/automation/"
26 "trex_control_plane/stl/")
28 from trex_stl_lib.api import *
31 def fmt_latency(lat_min, lat_avg, lat_max):
32 """Return formatted, rounded latency.
34 :param lat_min: Min latency
35 :param lat_avg: Average latency
36 :param lat_max: Max latency
40 :return: Formatted and rounded output "min/avg/max"
45 t_min = int(round(float(lat_min)))
49 t_avg = int(round(float(lat_avg)))
53 t_max = int(round(float(lat_max)))
57 return "/".join(str(tmp) for tmp in (t_min, t_avg, t_max))
60 def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
61 port_1, latency, async_start=False):
62 """Send the traffic and measure packet loss and latency.
65 - reads the given traffic profile with streams,
66 - connects to the T-rex client,
68 - removes all existing streams,
69 - adds streams from the traffic profile to the ports,
70 - if the warm-up time is more than 0, sends the warm-up traffic, reads the
72 - clears the statistics from the client,
74 - waits for the defined time (or runs forever if async mode is defined),
76 - reads and displays the statistics and
77 - disconnects from the client.
79 :param profile_file: A python module with T-rex traffic profile.
80 :param framesize: Frame size.
81 :param duration: Duration of traffic run in seconds (-1=infinite).
82 :param rate: Traffic rate [percentage, pps, bps].
83 :param warmup_time: Traffic warm-up time in seconds, 0 = disable.
84 :param port_0: Port 0 on the traffic generator.
85 :param port_1: Port 1 on the traffic generator.
86 :param latency: With latency stats.
87 :param async_start: Start the traffic and exit.
88 :type profile_file: str
89 :type framesize: int or str
92 :type warmup_time: int
96 :type async_start: bool
109 print("### Profile file:\n{}".format(profile_file))
110 profile = STLProfile.load(profile_file, direction=0, port_id=0,
112 streams = profile.get_streams()
113 except STLError as err:
114 print("Error while loading profile '{0}' {1}".format(profile_file, err))
119 client = STLClient(verbose_level=LoggerApi.VERBOSE_QUIET)
122 # Prepare our ports (the machine has 0 <--> 1 with static route):
123 client.reset(ports=[port_0, port_1])
124 client.remove_all_streams(ports=[port_0, port_1])
126 if "macsrc" in profile_file:
127 client.set_port_attr(ports=[port_0, port_1], promiscuous=True,
129 if isinstance(framesize, int):
130 client.add_streams(streams[0], ports=[port_0])
131 client.add_streams(streams[1], ports=[port_1])
132 elif isinstance(framesize, str):
133 client.add_streams(streams[0:3], ports=[port_0])
134 client.add_streams(streams[3:6], ports=[port_1])
137 if isinstance(framesize, int):
138 client.add_streams(streams[2], ports=[port_0])
139 client.add_streams(streams[3], ports=[port_1])
140 elif isinstance(framesize, str):
143 # Disable latency if NIC does not support requested stream type
144 print("##### FAILED to add latency streams #####")
148 # Clear the stats before injecting:
151 # Choose rate and start traffic:
152 client.start(ports=[port_0, port_1], mult=rate,
153 duration=warmup_time)
156 client.wait_on_traffic(ports=[port_0, port_1],
157 timeout=warmup_time+30)
159 if client.get_warnings():
160 for warning in client.get_warnings():
163 # Read the stats after the test:
164 stats = client.get_stats()
166 print("##### Warmup statistics #####")
167 print(json.dumps(stats, indent=4, separators=(',', ': '),
170 lost_a = stats[0]["opackets"] - stats[1]["ipackets"]
171 lost_b = stats[1]["opackets"] - stats[0]["ipackets"]
173 print("\npackets lost from 0 --> 1: {0} pkts".format(lost_a))
174 print("packets lost from 1 --> 0: {0} pkts".format(lost_b))
176 # Clear the stats before injecting:
181 # Choose rate and start traffic:
182 client.start(ports=[port_0, port_1], mult=rate, duration=duration)
186 client.wait_on_traffic(ports=[port_0, port_1], timeout=duration+30)
188 if client.get_warnings():
189 for warning in client.get_warnings():
192 # Read the stats after the test
193 stats = client.get_stats()
195 print("##### Statistics #####")
196 print(json.dumps(stats, indent=4, separators=(',', ': '),
199 lost_a = stats[0]["opackets"] - stats[1]["ipackets"]
200 lost_b = stats[1]["opackets"] - stats[0]["ipackets"]
204 str(stats["latency"][0]["latency"]["total_min"]),
205 str(stats["latency"][0]["latency"]["average"]),
206 str(stats["latency"][0]["latency"]["total_max"]))
208 str(stats["latency"][1]["latency"]["total_min"]),
209 str(stats["latency"][1]["latency"]["average"]),
210 str(stats["latency"][1]["latency"]["total_max"]))
212 total_sent = stats[0]["opackets"] + stats[1]["opackets"]
213 total_rcvd = stats[0]["ipackets"] + stats[1]["ipackets"]
215 print("\npackets lost from 0 --> 1: {0} pkts".format(lost_a))
216 print("packets lost from 1 --> 0: {0} pkts".format(lost_b))
218 except STLError as err:
219 sys.stderr.write("{0}\n".format(err))
225 client.disconnect(stop_traffic=False, release_ports=True)
229 print("rate={0}, totalReceived={1}, totalSent={2}, "
230 "frameLoss={3}, latencyStream0(usec)={4}, "
231 "latencyStream1(usec)={5}".
232 format(rate, total_rcvd, total_sent, lost_a + lost_b,
237 """Main function for the traffic generator using T-rex.
239 It verifies the given command line arguments and runs "simple_burst"
243 parser = argparse.ArgumentParser()
244 parser.add_argument("-p", "--profile",
247 help="Python traffic profile.")
248 parser.add_argument("-d", "--duration",
251 help="Duration of traffic run.")
252 parser.add_argument("-s", "--frame_size",
254 help="Size of a Frame without padding and IPG.")
255 parser.add_argument("-r", "--rate",
257 help="Traffic rate with included units (%, pps).")
258 parser.add_argument("-w", "--warmup_time",
261 help="Traffic warm-up time in seconds, 0 = disable.")
262 parser.add_argument("--port_0",
265 help="Port 0 on the traffic generator.")
266 parser.add_argument("--port_1",
269 help="Port 1 on the traffic generator.")
270 parser.add_argument("--async",
273 help="Non-blocking call of the script.")
274 parser.add_argument("--latency",
277 help="Add latency stream")
278 args = parser.parse_args()
281 framesize = int(args.frame_size)
283 framesize = args.frame_size
285 simple_burst(profile_file=args.profile,
286 duration=int(args.duration),
289 warmup_time=int(args.warmup_time),
290 port_0=int(args.port_0),
291 port_1=int(args.port_1),
292 latency=args.latency,
293 async_start=args.async)
296 if __name__ == '__main__':