3 # Copyright (c) 2019 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.61/scripts/automation/"
26 "trex_control_plane/interactive/")
27 from trex.stl.api import *
30 def fmt_latency(lat_min, lat_avg, lat_max, hdrh):
31 """Return formatted, rounded latency.
33 :param lat_min: Min latency
34 :param lat_avg: Average latency
35 :param lat_max: Max latency
36 :param hdrh: Base64 encoded compressed HDRHistogram object.
41 :return: Formatted and rounded output (hdrh unchanged) "min/avg/max/hdrh".
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, hdrh))
60 def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
61 port_1, latency, async_start=False, traffic_directions=2):
62 """Send 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 :param traffic_directions: Bidirectional (2) or unidirectional (1) traffic.
89 :type profile_file: str
90 :type framesize: int or str
93 :type warmup_time: float
97 :type async_start: bool
98 :type traffic_directions: int
110 print("### Profile file:\n{}".format(profile_file))
111 profile = STLProfile.load(profile_file, direction=0, port_id=0,
113 streams = profile.get_streams()
114 except STLError as err:
115 print("Error while loading profile '{0}' {1}".format(profile_file, err))
123 # Prepare our ports (the machine has 0 <--> 1 with static route):
124 client.reset(ports=[port_0, port_1])
125 client.remove_all_streams(ports=[port_0, port_1])
127 if "macsrc" in profile_file:
128 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 if traffic_directions > 1:
132 client.add_streams(streams[1], ports=[port_1])
133 elif isinstance(framesize, str):
134 client.add_streams(streams[0:3], ports=[port_0])
135 if traffic_directions > 1:
136 client.add_streams(streams[3:6], ports=[port_1])
139 if isinstance(framesize, int):
140 client.add_streams(streams[2], ports=[port_0])
141 if traffic_directions > 1:
142 client.add_streams(streams[3], ports=[port_1])
143 elif isinstance(framesize, str):
146 # Disable latency if NIC does not support requested stream type
147 print("##### FAILED to add latency streams #####")
150 if traffic_directions > 1:
154 # Clear the stats before injecting:
157 # Choose rate and start traffic:
158 client.start(ports=ports, mult=rate, duration=warmup_time)
161 client.wait_on_traffic(ports=ports, timeout=warmup_time+30)
163 if client.get_warnings():
164 for warning in client.get_warnings():
167 # Read the stats after the test:
168 stats = client.get_stats()
170 print("##### Warmup statistics #####")
171 print(json.dumps(stats, indent=4, separators=(',', ': ')))
173 lost_a = stats[port_0]["opackets"] - stats[port_1]["ipackets"]
174 if traffic_directions > 1:
175 lost_b = stats[port_1]["opackets"] - stats[port_0]["ipackets"]
177 print("\npackets lost from {p_0} --> {p_1}: {v} pkts".format(
178 p_0=port_0, p_1=port_1, v=lost_a))
179 if traffic_directions > 1:
180 print("packets lost from {p_1} --> {p_0}: {v} pkts".format(
181 p_0=port_0, p_1=port_1, v=lost_b))
183 # Clear the stats before injecting:
188 # Choose rate and start traffic:
189 client.start(ports=ports, mult=rate, duration=duration)
192 # For async stop, we need to export the current snapshot.
193 xsnap0 = client.ports[0].get_xstats().reference_stats
194 print("Xstats snapshot 0: {s!r}".format(s=xsnap0))
195 if traffic_directions > 1:
196 xsnap1 = client.ports[1].get_xstats().reference_stats
197 print("Xstats snapshot 1: {s!r}".format(s=xsnap1))
200 client.wait_on_traffic(ports=ports, timeout=duration+30)
202 if client.get_warnings():
203 for warning in client.get_warnings():
206 # Read the stats after the test
207 stats = client.get_stats()
209 print("##### Statistics #####")
210 print(json.dumps(stats, indent=4, separators=(',', ': ')))
212 lost_a = stats[port_0]["opackets"] - stats[port_1]["ipackets"]
213 if traffic_directions > 1:
214 lost_b = stats[port_1]["opackets"] - stats[port_0]["ipackets"]
216 # Stats index is not a port number, but "pgid".
217 # TODO: Find out what "pgid" means.
219 lat_obj = stats["latency"][0]["latency"]
221 str(lat_obj["total_min"]), str(lat_obj["average"]),
222 str(lat_obj["total_max"]), str(lat_obj["hdrh"]))
223 if traffic_directions > 1:
224 lat_obj = stats["latency"][1]["latency"]
226 str(lat_obj["total_min"]), str(lat_obj["average"]),
227 str(lat_obj["total_max"]), str(lat_obj["hdrh"]))
229 if traffic_directions > 1:
230 total_sent = stats[0]["opackets"] + stats[1]["opackets"]
231 total_rcvd = stats[0]["ipackets"] + stats[1]["ipackets"]
233 total_sent = stats[port_0]["opackets"]
234 total_rcvd = stats[port_1]["ipackets"]
236 print("\npackets lost from {p_0} --> {p_1}: {v} pkts".format(
237 p_0=port_0, p_1=port_1, v=lost_a))
238 if traffic_directions > 1:
239 print("packets lost from {p_1} --> {p_0}: {v} pkts".format(
240 p_0=port_0, p_1=port_1, v=lost_b))
242 except STLError as ex_error:
243 print(ex_error, file=sys.stderr)
249 client.disconnect(stop_traffic=False, release_ports=True)
253 print("rate={0!r}, totalReceived={1}, totalSent={2}, "
254 "frameLoss={3}, latencyStream0(usec)={4}, "
255 "latencyStream1(usec)={5}, targetDuration={d!r}".
256 format(rate, total_rcvd, total_sent, lost_a + lost_b,
257 lat_a, lat_b, d=duration))
261 """Main function for the traffic generator using T-rex.
263 It verifies the given command line arguments and runs "simple_burst"
266 parser = argparse.ArgumentParser()
267 parser.add_argument("-p", "--profile",
270 help="Python traffic profile.")
271 parser.add_argument("-d", "--duration",
274 help="Duration of traffic run.")
275 parser.add_argument("-s", "--frame_size",
277 help="Size of a Frame without padding and IPG.")
278 parser.add_argument("-r", "--rate",
280 help="Traffic rate with included units (%, pps).")
281 parser.add_argument("-w", "--warmup_time",
284 help="Traffic warm-up time in seconds, 0 = disable.")
285 parser.add_argument("--port_0",
288 help="Port 0 on the traffic generator.")
289 parser.add_argument("--port_1",
292 help="Port 1 on the traffic generator.")
293 parser.add_argument("--async_start",
296 help="Non-blocking call of the script.")
297 parser.add_argument("--latency",
300 help="Add latency stream.")
301 parser.add_argument("--traffic_directions",
304 help="Send bi- (2) or uni- (1) directional traffic.")
306 args = parser.parse_args()
309 framesize = int(args.frame_size)
311 framesize = args.frame_size
313 simple_burst(profile_file=args.profile,
314 duration=args.duration,
317 warmup_time=args.warmup_time,
320 latency=args.latency,
321 async_start=args.async_start,
322 traffic_directions=args.traffic_directions)
325 if __name__ == '__main__':