Avoid !r format appending u on unicode
[csit.git] / resources / tools / trex / trex_stateless_profile.py
1 #!/usr/bin/python
2
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:
7 #
8 #     http://www.apache.org/licenses/LICENSE-2.0
9 #
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.
15
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
18 latency.
19 """
20
21 import sys
22 import argparse
23 import json
24
25 sys.path.insert(0, "/opt/trex-core-2.35/scripts/automation/"
26                    "trex_control_plane/stl/")
27
28 from trex_stl_lib.api import *
29
30
31 def fmt_latency(lat_min, lat_avg, lat_max):
32     """Return formatted, rounded latency.
33
34     :param lat_min: Min latency
35     :param lat_avg: Average latency
36     :param lat_max: Max latency
37     :type lat_min: string
38     :type lat_avg: string
39     :type lat_max: string
40     :return: Formatted and rounded output "min/avg/max"
41     :rtype: string
42     """
43
44     try:
45         t_min = int(round(float(lat_min)))
46     except ValueError:
47         t_min = int(-1)
48     try:
49         t_avg = int(round(float(lat_avg)))
50     except ValueError:
51         t_avg = int(-1)
52     try:
53         t_max = int(round(float(lat_max)))
54     except ValueError:
55         t_max = int(-1)
56
57     return "/".join(str(tmp) for tmp in (t_min, t_avg, t_max))
58
59
60 def simple_burst(profile_file, duration, framesize, rate, warmup_time, port_0,
61                  port_1, latency, async_start=False, unidirection=False):
62     """Send traffic and measure packet loss and latency.
63
64     Procedure:
65      - reads the given traffic profile with streams,
66      - connects to the T-rex client,
67      - resets the ports,
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
71        statistics,
72      - clears the statistics from the client,
73      - starts the traffic,
74      - waits for the defined time (or runs forever if async mode is defined),
75      - stops the traffic,
76      - reads and displays the statistics and
77      - disconnects from the client.
78
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 unidirection: Traffic is unidirectional.
89     :type profile_file: str
90     :type framesize: int or str
91     :type duration: float
92     :type rate: str
93     :type warmup_time: float
94     :type port_0: int
95     :type port_1: int
96     :type latency: bool
97     :type async_start: bool
98     :type unidirection: bool
99     """
100
101     client = None
102     total_rcvd = 0
103     total_sent = 0
104     lost_a = 0
105     lost_b = 0
106     lat_a = "-1/-1/-1"
107     lat_b = "-1/-1/-1"
108
109     # Read the profile:
110     try:
111         print("### Profile file:\n{}".format(profile_file))
112         profile = STLProfile.load(profile_file, direction=0, port_id=0,
113                                   framesize=framesize)
114         streams = profile.get_streams()
115     except STLError as err:
116         print("Error while loading profile '{0}' {1}".format(profile_file, err))
117         sys.exit(1)
118
119     try:
120         # Create the client:
121         client = STLClient(verbose_level=LoggerApi.VERBOSE_QUIET)
122         # Connect to server:
123         client.connect()
124         # Prepare our ports (the machine has 0 <--> 1 with static route):
125         client.reset(ports=[port_0, port_1])
126         client.remove_all_streams(ports=[port_0, port_1])
127
128         if "macsrc" in profile_file:
129             client.set_port_attr(ports=[port_0, port_1], promiscuous=True,
130                                  resolve=False)
131         if isinstance(framesize, int):
132             client.add_streams(streams[0], ports=[port_0])
133             if not unidirection:
134                 client.add_streams(streams[1], ports=[port_1])
135         elif isinstance(framesize, str):
136             client.add_streams(streams[0:3], ports=[port_0])
137             if not unidirection:
138                 client.add_streams(streams[3:6], ports=[port_1])
139         if latency:
140             try:
141                 if isinstance(framesize, int):
142                     client.add_streams(streams[2], ports=[port_0])
143                     if not unidirection:
144                         client.add_streams(streams[3], ports=[port_1])
145                 elif isinstance(framesize, str):
146                     latency = False
147             except STLError:
148                 # Disable latency if NIC does not support requested stream type
149                 print("##### FAILED to add latency streams #####")
150                 latency = False
151         ports = [port_0]
152         if not unidirection:
153             ports.append(port_1)
154         # Warm-up phase:
155         if warmup_time > 0:
156             # Clear the stats before injecting:
157             client.clear_stats()
158
159             # Choose rate and start traffic:
160             client.start(ports=ports, mult=rate, duration=warmup_time)
161
162             # Block until done:
163             client.wait_on_traffic(ports=ports, timeout=warmup_time+30)
164
165             if client.get_warnings():
166                 for warning in client.get_warnings():
167                     print(warning)
168
169             # Read the stats after the test:
170             stats = client.get_stats()
171
172             print("##### Warmup statistics #####")
173             print(json.dumps(stats, indent=4, separators=(',', ': '),
174                              sort_keys=True))
175
176             lost_a = stats[port_0]["opackets"] - stats[port_1]["ipackets"]
177             if not unidirection:
178                 lost_b = stats[port_1]["opackets"] - stats[port_0]["ipackets"]
179
180             print("\npackets lost from {p_0} --> {p_1}: {v} pkts".format(
181                 p_0=port_0, p_1=port_1, v=lost_a))
182             if not unidirection:
183                 print("packets lost from {p_1} --> {p_0}: {v} pkts".format(
184                     p_0=port_0, p_1=port_1, v=lost_b))
185
186         # Clear the stats before injecting:
187         client.clear_stats()
188         lost_a = 0
189         lost_b = 0
190
191         # Choose rate and start traffic:
192         client.start(ports=ports, mult=rate, duration=duration)
193
194         if not async_start:
195             # Block until done:
196             client.wait_on_traffic(ports=ports, timeout=duration+30)
197
198             if client.get_warnings():
199                 for warning in client.get_warnings():
200                     print(warning)
201
202             # Read the stats after the test
203             stats = client.get_stats()
204
205             print("##### Statistics #####")
206             print(json.dumps(stats, indent=4, separators=(',', ': '),
207                              sort_keys=True))
208
209             lost_a = stats[port_0]["opackets"] - stats[port_1]["ipackets"]
210             if not unidirection:
211                 lost_b = stats[port_1]["opackets"] - stats[port_0]["ipackets"]
212
213             if latency:
214                 lat_a = fmt_latency(
215                     str(stats["latency"][port_0]["latency"]["total_min"]),
216                     str(stats["latency"][port_0]["latency"]["average"]),
217                     str(stats["latency"][port_0]["latency"]["total_max"]))
218                 if not unidirection:
219                     lat_b = fmt_latency(
220                         str(stats["latency"][port_1]["latency"]["total_min"]),
221                         str(stats["latency"][port_1]["latency"]["average"]),
222                         str(stats["latency"][port_1]["latency"]["total_max"]))
223
224             if not unidirection:
225                 total_sent = stats[0]["opackets"] + stats[1]["opackets"]
226                 total_rcvd = stats[0]["ipackets"] + stats[1]["ipackets"]
227             else:
228                 total_sent = stats[port_0]["opackets"]
229                 total_rcvd = stats[port_1]["ipackets"]
230
231             print("\npackets lost from {p_0} --> {p_1}:   {v} pkts".format(
232                 p_0=port_0, p_1=port_1, v=lost_a))
233             if not unidirection:
234                 print("packets lost from {p_1} --> {p_0}:   {v} pkts".format(
235                 p_0=port_0, p_1=port_1, v=lost_b))
236
237     except STLError as err:
238         sys.stderr.write("{0}\n".format(err))
239         sys.exit(1)
240
241     finally:
242         if async_start:
243             if client:
244                 client.disconnect(stop_traffic=False, release_ports=True)
245         else:
246             if client:
247                 client.disconnect()
248             if isinstance(rate, unicode):
249                 rate = rate.encode("utf-8")
250             if isinstance(duration, unicode):
251                 duration = duration.encode("utf-8")
252             print("rate={0!r}, totalReceived={1}, totalSent={2}, "
253                   "frameLoss={3}, latencyStream0(usec)={4}, "
254                   "latencyStream1(usec)={5}, targetDuration={d!r}".
255                   format(rate, total_rcvd, total_sent, lost_a + lost_b,
256                          lat_a, lat_b, d=duration))
257
258
259 def main():
260     """Main function for the traffic generator using T-rex.
261
262     It verifies the given command line arguments and runs "simple_burst"
263     function.
264     """
265
266     parser = argparse.ArgumentParser()
267     parser.add_argument("-p", "--profile",
268                         required=True,
269                         type=str,
270                         help="Python traffic profile.")
271     parser.add_argument("-d", "--duration",
272                         required=True,
273                         type=float,
274                         help="Duration of traffic run.")
275     parser.add_argument("-s", "--frame_size",
276                         required=True,
277                         help="Size of a Frame without padding and IPG.")
278     parser.add_argument("-r", "--rate",
279                         required=True,
280                         help="Traffic rate with included units (%, pps).")
281     parser.add_argument("-w", "--warmup_time",
282                         type=float,
283                         default=5.0,
284                         help="Traffic warm-up time in seconds, 0 = disable.")
285     parser.add_argument("--port_0",
286                         required=True,
287                         type=int,
288                         help="Port 0 on the traffic generator.")
289     parser.add_argument("--port_1",
290                         required=True,
291                         type=int,
292                         help="Port 1 on the traffic generator.")
293     parser.add_argument("--async",
294                         action="store_true",
295                         default=False,
296                         help="Non-blocking call of the script.")
297     parser.add_argument("--latency",
298                         action="store_true",
299                         default=False,
300                         help="Add latency stream.")
301     parser.add_argument("--unidirection",
302                         action="store_true",
303                         default=False,
304                         help="Send unidirection traffic.")
305
306     args = parser.parse_args()
307
308     try:
309         framesize = int(args.frame_size)
310     except ValueError:
311         framesize = args.frame_size
312
313     simple_burst(profile_file=args.profile,
314                  duration=args.duration,
315                  framesize=framesize,
316                  rate=args.rate,
317                  warmup_time=args.warmup_time,
318                  port_0=args.port_0,
319                  port_1=args.port_1,
320                  latency=args.latency,
321                  async_start=args.async,
322                  unidirection=args.unidirection)
323
324
325 if __name__ == '__main__':
326     main()

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.