"""
+import argparse
import json
+import socket
import string
-import sys, getopt
+import struct
+import sys
-sys.path.insert(0, "/opt/trex-core-2.00/scripts/automation/"+\
+sys.path.insert(0, "/opt/trex-core-2.03/scripts/automation/"+\
"trex_control_plane/stl/")
from trex_stl_lib.api import *
def generate_payload(length):
- """Generate random payload.
+ """Generate payload.
:param length: Length of payload.
:type length: int
- :return: Payload filled with random chars.
+ :return: Payload filled with chars.
:rtype string
"""
return word
+
+def get_start_end_ipv6(start_ip, end_ip):
+ """Get start and end host from IPv6 as integer.
+
+ :param start_ip: Start IPv6.
+ :param end_ip: End IPv6.
+ :type start_ip: string
+ :type end_ip: string
+ :return: Start host, end host.
+ :rtype int
+ """
+
+ try:
+ ip1 = socket.inet_pton(socket.AF_INET6, start_ip)
+ ip2 = socket.inet_pton(socket.AF_INET6, end_ip)
+
+ hi1, lo1 = struct.unpack('!QQ', ip1)
+ hi2, lo2 = struct.unpack('!QQ', ip2)
+
+ if ((hi1 << 64) | lo1) > ((hi2 << 64) | lo2):
+ print "IPv6: start_ip is greater then end_ip"
+ sys.exit(2)
+
+ max_p1 = abs(int(lo1) - int(lo2)) + 1
+ base_p1 = lo1
+ except AddressValueError as ex_error:
+ print ex_error
+ sys.exit(2)
+
+ return base_p1, max_p1
+
+
def create_packets(traffic_options, frame_size=64):
"""Create two IP packets to be used in stream.
:type traffic_options: list
:type frame_size: int
:return: Packet instances.
- :rtype STLPktBuilder
+ :rtype: Tuple of STLPktBuilder
"""
if frame_size < 64:
STLVmWrFlowVar(fv_name="src", pkt_offset="IP.src"),
STLVmFixIpv4(offset="IP"),
], split_by_field="src")
-
# The following code applies raw instructions to packet (IP src increment).
# It splits the generated traffic by "ip_src" variable to cores and fix
# IPv4 header checksum.
max(0, fsize_no_fcs-len(base_pkt_a))), vm=vm1)
pkt_b = STLPktBuilder(pkt=base_pkt_b/generate_payload(
max(0, fsize_no_fcs-len(base_pkt_b))), vm=vm2)
+ lat_a = STLPktBuilder(pkt=base_pkt_a/generate_payload(
+ max(0, fsize_no_fcs-len(base_pkt_a))))
+ lat_b = STLPktBuilder(pkt=base_pkt_b/generate_payload(
+ max(0, fsize_no_fcs-len(base_pkt_b))))
+
+ return(pkt_a, pkt_b, lat_a, lat_b)
+
+
+def create_packets_v6(traffic_options, frame_size=78):
+ """Create two IPv6 packets to be used in stream.
+
+ :param traffic_options: Parameters for packets.
+ :param frame_size: Size of L2 frame.
+ :type traffic_options: List
+ :type frame_size: int
+ :return: Packet instances.
+ :rtype: Tuple of STLPktBuilder
+ """
+
+ if frame_size < 78:
+ print "Packet min. size is 78B"
+ sys.exit(2)
+
+ fsize_no_fcs = frame_size - 4 # no FCS
+
+ p1_src_start_ip = traffic_options['p1_src_start_ip']
+ p1_src_end_ip = traffic_options['p1_src_end_ip']
+ p1_dst_start_ip = traffic_options['p1_dst_start_ip']
+ p2_src_start_ip = traffic_options['p2_src_start_ip']
+ p2_src_end_ip = traffic_options['p2_src_end_ip']
+ p2_dst_start_ip = traffic_options['p2_dst_start_ip']
+
+ base_p1, max_p1 = get_start_end_ipv6(p1_src_start_ip, p1_src_end_ip)
+ base_p2, max_p2 = get_start_end_ipv6(p2_src_start_ip, p2_src_end_ip)
+
+ base_pkt_a = Ether()/IPv6(src=p1_src_start_ip, dst=p1_dst_start_ip)
+ base_pkt_b = Ether()/IPv6(src=p2_src_start_ip, dst=p2_dst_start_ip)
+
+ # The following code applies raw instructions to packet (IP src increment).
+ # It splits the generated traffic by "ip_src" variable to cores
+ vm1 = STLScVmRaw([STLVmFlowVar(name="ipv6_src",
+ min_value=base_p1,
+ max_value=max_p1+base_p1,
+ size=8, op="inc"),
+ STLVmWrFlowVar(fv_name="ipv6_src", pkt_offset="IPv6.src",
+ offset_fixup=8)
+ ]
+ , split_by_field="ipv6_src")
- return(pkt_a, pkt_b)
+ # The following code applies raw instructions to packet (IP src increment).
+ # It splits the generated traffic by "ip_src" variable to cores
+ vm2 = STLScVmRaw([STLVmFlowVar(name="ipv6_src",
+ min_value=base_p2,
+ max_value=max_p2+base_p2,
+ size=8, op="inc"),
+ STLVmWrFlowVar(fv_name="ipv6_src", pkt_offset="IPv6.src",
+ offset_fixup=8)
+ ]
+ , split_by_field="ipv6_src")
-def simple_burst(pkt_a, pkt_b, duration=10, rate="1mpps", warmup_time=5):
+ pkt_a = STLPktBuilder(pkt=base_pkt_a/generate_payload(
+ max(0, fsize_no_fcs-len(base_pkt_a))), vm=vm1)
+ pkt_b = STLPktBuilder(pkt=base_pkt_b/generate_payload(
+ max(0, fsize_no_fcs-len(base_pkt_b))), vm=vm2)
+ lat_a = STLPktBuilder(pkt=base_pkt_a/generate_payload(
+ max(0, fsize_no_fcs-len(base_pkt_a))))
+ lat_b = STLPktBuilder(pkt=base_pkt_b/generate_payload(
+ max(0, fsize_no_fcs-len(base_pkt_b))))
+
+ return(pkt_a, pkt_b, lat_a, lat_b)
+
+
+def simple_burst(pkt_a, pkt_b, pkt_lat_a, pkt_lat_b, duration, rate,
+ warmup_time, async_start, latency):
"""Run the traffic with specific parameters.
:param pkt_a: Base packet for stream 1.
:param pkt_b: Base packet for stream 2.
- :param duration: Duration of traffic run in seconds.
+ :param pkt_lat_a: Base packet for latency stream 1.
+ :param pkt_lat_b: Base packet for latency stream 2.
+ :param duration: Duration of traffic run in seconds (-1=infinite).
:param rate: Rate of traffic run [percentage, pps, bps].
:param warmup_time: Warm up duration.
+ :param async_start: Start the traffic and exit.
+ :param latency: With latency stats.
:type pkt_a: STLPktBuilder
:type pkt_b: STLPktBuilder
+ :type pkt_lat_a: STLPktBuilder
+ :type pkt_lat_b: STLPktBuilder
:type duration: int
:type rate: string
:type warmup_time: int
+ :type async_start: bool
+ :type latency: bool
:return: nothing
"""
total_sent = 0
lost_a = 0
lost_b = 0
+ lat_a = 'NA'
+ lat_b = 'NA'
try:
# turn this off if too many logs
#client.set_verbose("high")
- # create two streams
- stream1 = STLStream(packet=pkt_a,
- mode=STLTXCont(pps=100))
-
- # second stream with a phase of 10ns (inter stream gap)
- stream2 = STLStream(packet=pkt_b,
- isg=10.0,
- mode=STLTXCont(pps=100))
-
-
# connect to server
client.connect()
# prepare our ports (my machine has 0 <--> 1 with static route)
client.reset(ports=[0, 1])
- # add both streams to ports
+ # create two traffic streams without latency stats
+ stream1 = STLStream(packet=pkt_a,
+ mode=STLTXCont(pps=1000))
+ # second traffic stream with a phase of 10ns (inter stream gap)
+ stream2 = STLStream(packet=pkt_b,
+ isg=10.0,
+ mode=STLTXCont(pps=1000))
client.add_streams(stream1, ports=[0])
client.add_streams(stream2, ports=[1])
+ if latency:
+ # create two traffic streams with latency stats
+ lat_stream1 = STLStream(packet=pkt_lat_a,
+ flow_stats=STLFlowLatencyStats(pg_id=0),
+ mode=STLTXCont(pps=1000))
+ # second traffic stream with a phase of 10ns (inter stream gap)
+ lat_stream2 = STLStream(packet=pkt_lat_b,
+ isg=10.0,
+ flow_stats=STLFlowLatencyStats(pg_id=1),
+ mode=STLTXCont(pps=1000))
+ client.add_streams(lat_stream1, ports=[0])
+ client.add_streams(lat_stream2, ports=[1])
+
#warmup phase
- if warmup_time is not None:
+ if warmup_time > 0:
+ # clear the stats before injecting
client.clear_stats()
+
+ # choose rate and start traffic
client.start(ports=[0, 1], mult=rate, duration=warmup_time)
- client.wait_on_traffic(ports=[0, 1], timeout=(duration+30))
+
+ # block until done
+ client.wait_on_traffic(ports=[0, 1], timeout=(warmup_time+30))
+
+ if client.get_warnings():
+ for warning in client.get_warnings():
+ print_error(warning)
+
+ # read the stats after the test
stats = client.get_stats()
- print stats
+
print "#####warmup statistics#####"
print json.dumps(stats, indent=4,
separators=(',', ': '), sort_keys=True)
print "\npackets lost from 0 --> 1: {0} pkts".format(lost_a)
print "packets lost from 1 --> 0: {0} pkts".format(lost_b)
-
# clear the stats before injecting
client.clear_stats()
+ lost_a = 0
+ lost_b = 0
# choose rate and start traffic
client.start(ports=[0, 1], mult=rate, duration=duration)
- # block until done
- client.wait_on_traffic(ports=[0, 1], timeout=(duration+30))
+ if not async_start:
+ # block until done
+ client.wait_on_traffic(ports=[0, 1], timeout=(duration+30))
+
+ if client.get_warnings():
+ for warning in client.get_warnings():
+ print_error(warning)
- # read the stats after the test
- stats = client.get_stats()
+ # read the stats after the test
+ stats = client.get_stats()
- print "#####statistics#####"
- print json.dumps(stats, indent=4,
- separators=(',', ': '), sort_keys=True)
+ print "#####statistics#####"
+ print json.dumps(stats, indent=4,
+ separators=(',', ': '), sort_keys=True)
+ lost_a = stats[0]["opackets"] - stats[1]["ipackets"]
+ lost_b = stats[1]["opackets"] - stats[0]["ipackets"]
- lost_a = stats[0]["opackets"] - stats[1]["ipackets"]
- lost_b = stats[1]["opackets"] - stats[0]["ipackets"]
+ if latency:
+ lat_a = "/".join((\
+ str(stats["latency"][0]["latency"]["total_min"]),\
+ str(stats["latency"][0]["latency"]["average"]),\
+ str(stats["latency"][0]["latency"]["total_max"])))
+ lat_b = "/".join((\
+ str(stats["latency"][1]["latency"]["total_min"]),\
+ str(stats["latency"][1]["latency"]["average"]),\
+ str(stats["latency"][1]["latency"]["total_max"])))
- total_sent = stats[0]["opackets"] + stats[1]["opackets"]
- total_rcvd = stats[0]["ipackets"] + stats[1]["ipackets"]
+ total_sent = stats[0]["opackets"] + stats[1]["opackets"]
+ total_rcvd = stats[0]["ipackets"] + stats[1]["ipackets"]
- print "\npackets lost from 0 --> 1: {0} pkts".format(lost_a)
- print "packets lost from 1 --> 0: {0} pkts".format(lost_b)
+ print "\npackets lost from 0 --> 1: {0} pkts".format(lost_a)
+ print "packets lost from 1 --> 0: {0} pkts".format(lost_b)
except STLError as ex_error:
print_error(str(ex_error))
sys.exit(1)
finally:
- client.disconnect()
- print "rate={0}, totalReceived={1}, totalSent={2}, frameLoss={3}"\
- .format(rate, total_rcvd, total_sent, lost_a+lost_b)
-
-
-def print_help():
- """Print help on stdout."""
-
- print "args: [-h] -d <duration> -s <size of frame in bytes>"+\
- " [-r] <traffic rate with unit: %, mpps> "+\
- "--p1_src_mac <port1_src_mac> "+\
- "--p1_dst_mac <port1_dst_mac> "+\
- "--p1_src_start_ip <port1_src_start_ip> "+\
- "--p1_src_end_ip <port1_src_end_ip> "+\
- "--p1_dst_start_ip <port1_dst_start_ip> "+\
- "--p1_dst_end_ip <port1_dst_end_ip> "+\
- "--p2_src_mac <port2_src_mac> "+\
- "--p2_dst_mac <port2_dst_mac> "+\
- "--p2_src_start_ip <port2_src_start_ip> "+\
- "--p2_src_end_ip <port2_src_end_ip> "+\
- "--p2_dst_start_ip <port2_dst_start_ip> "+\
- "--p2_dst_end_ip <port2_dst_end_ip>"
+ if async_start:
+ client.disconnect(stop_traffic=False, release_ports=True)
+ else:
+ client.disconnect()
+ print "rate={0}, totalReceived={1}, totalSent={2}, "\
+ "frameLoss={3}, latencyStream0(usec)={4}, "\
+ "latencyStream1(usec)={5}".format(rate, total_rcvd,\
+ total_sent, lost_a+lost_b, lat_a, lat_b)
+
def print_error(msg):
"""Print error message on stderr.
sys.stderr.write(msg+'\n')
-def main(argv):
+def parse_args():
+ """Parse arguments from cmd line.
+
+ :return: Parsed arguments.
+ :rtype ArgumentParser
+ """
+
+ parser = argparse.ArgumentParser()
+ parser.add_argument("-d", "--duration", required=True, type=int,
+ help="Duration of traffic run")
+ parser.add_argument("-s", "--frame_size", required=True, type=int,
+ help="Size of a Frame without padding and IPG")
+ parser.add_argument("-r", "--rate", required=True,
+ help="Traffic rate with included units (%, pps)")
+ parser.add_argument("-6", "--use_IPv6", action="store_true",
+ default=False,
+ help="Use IPv6 traffic profile instead of IPv4")
+ parser.add_argument("--async", action="store_true",
+ default=False,
+ help="Non-blocking call of the script")
+ parser.add_argument("--latency", action="store_true",
+ default=False,
+ help="Add latency stream")
+ parser.add_argument("-w", "--warmup_time", type=int,
+ default=5,
+ help="Traffic warmup time in seconds, 0 = disable")
+# parser.add_argument("--p1_src_mac",
+# help="Port 1 source MAC address")
+# parser.add_argument("--p1_dst_mac",
+# help="Port 1 destination MAC address")
+ parser.add_argument("--p1_src_start_ip", required=True,
+ help="Port 1 source start IP address")
+ parser.add_argument("--p1_src_end_ip", required=True,
+ help="Port 1 source end IP address")
+ parser.add_argument("--p1_dst_start_ip", required=True,
+ help="Port 1 destination start IP address")
+# parser.add_argument("--p1_dst_end_ip",
+# help="Port 1 destination end IP address")
+# parser.add_argument("--p2_src_mac",
+# help="Port 2 source MAC address")
+# parser.add_argument("--p2_dst_mac",
+# help="Port 2 destination MAC address")
+ parser.add_argument("--p2_src_start_ip", required=True,
+ help="Port 2 source start IP address")
+ parser.add_argument("--p2_src_end_ip", required=True,
+ help="Port 2 source end IP address")
+ parser.add_argument("--p2_dst_start_ip", required=True,
+ help="Port 2 destination start IP address")
+# parser.add_argument("--p2_dst_end_ip",
+# help="Port 2 destination end IP address")
+
+ return parser.parse_args()
+
+
+def main():
"""Main function."""
- _duration = 10
- _frame_size = 64
- _rate = '1mpps'
+ args = parse_args()
+
+ _duration = args.duration
+ _frame_size = args.frame_size
+ _rate = args.rate
+ _use_ipv6 = args.use_IPv6
+ _async_call = args.async
+ _latency = args.latency
+ _warmup_time = args.warmup_time
+
_traffic_options = {}
+ for attr in [a for a in dir(args) if a.startswith('p')]:
+ if getattr(args, attr) is not None:
+ _traffic_options[attr] = getattr(args, attr)
- try:
- opts, _ = getopt.getopt(argv, "hd:s:r:o:",
- ["help",
- "p1_src_mac=",
- "p1_dst_mac=",
- "p1_src_start_ip=",
- "p1_src_end_ip=",
- "p1_dst_start_ip=",
- "p1_dst_end_ip=",
- "p2_src_mac=",
- "p2_dst_mac=",
- "p2_src_start_ip=",
- "p2_src_end_ip=",
- "p2_dst_start_ip=",
- "p2_dst_end_ip="])
- except getopt.GetoptError:
- print_help()
- sys.exit(1)
- for opt, arg in opts:
- if opt in ('-h', "--help"):
- print_help()
- sys.exit()
- elif opt == '-d':
- _duration = int(arg)
- elif opt == '-s':
- _frame_size = int(arg)
- elif opt == '-r':
- _rate = arg
- elif opt.startswith("--p"):
- _traffic_options[opt[2:]] = arg
-
- print _traffic_options
- if len(_traffic_options) != 6:
- print_error("Supported only: src_start_ip, src_end_ip, dst_start_ip")
- print_help()
- sys.exit(1)
+ if _use_ipv6:
+ # WARNING: Trex limitation to IPv4 only. IPv6 is not yet supported.
+ print_error('IPv6 latency is not supported yet. Running without lat.')
+ _latency = False
- pkt_a, pkt_b = create_packets(_traffic_options,
- frame_size=_frame_size)
+ pkt_a, pkt_b, lat_a, lat_b = create_packets_v6(_traffic_options,
+ frame_size=_frame_size)
+ else:
+ pkt_a, pkt_b, lat_a, lat_b = create_packets(_traffic_options,
+ frame_size=_frame_size)
- simple_burst(pkt_a, pkt_b, duration=_duration, rate=_rate)
+ simple_burst(pkt_a, pkt_b, lat_a, lat_b, _duration, _rate, _warmup_time,
+ _async_call, _latency)
if __name__ == "__main__":
- main(sys.argv[1:])
-
+ sys.exit(main())