1 # Copyright (c) 2020 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Traffic profile for T-rex advanced stateful (astf) traffic generator.
17 - Two streams sent in directions 0 --> 1 (client -> server, requests) and
18 1 --> 0 (server -> client, responses) at the same time.
19 - Packet: ETH / IP / UDP
21 - Source IP address range: 192.168.0.0 - 192.168.63.255
22 - Destination IP address range: 20.0.0.0 - 20.0.63.255
24 - Source IP address range: destination IP address from packet received
26 - Destination IP address range: source IP address from packet received
30 from trex.astf.api import *
32 from profile_trex_astf_base_class import TrafficProfileBaseClass
35 class TrafficProfile(TrafficProfileBaseClass):
36 """Traffic profile."""
39 """Initialization and setting of profile parameters."""
41 super(TrafficProfileBaseClass, self).__init__()
43 # IPs used in packet headers.
44 self.p1_src_start_ip = u"192.168.0.0"
45 self.p1_src_end_ip = u"192.168.63.255"
46 self.p1_dst_start_ip = u"20.0.0.0"
47 self.p1_dst_end_ip = u"20.0.63.255"
54 self.headers_size = 42 # 14B l2 + 20B ipv4 + 8B udp
56 # Required UDP keepalive value for T-Rex
57 self.udp_keepalive = 2000 # 2s (2,000 msec)
59 def define_profile(self):
60 """Define profile to be used by advanced stateful traffic generator.
62 This method MUST return:
63 return ip_gen, templates, None
65 :returns: IP generator and profile templates ASTFProfile().
68 self.udp_req += self._gen_padding(self.headers_size + len(self.udp_req))
69 self.udp_res += self._gen_padding(self.headers_size + len(self.udp_res))
72 prog_c = ASTFProgram(stream=False)
73 # set the keepalive timer for UDP flows to not close udp session
74 # immediately after packet exchange
75 prog_c.set_keepalive_msg(self.udp_keepalive)
77 prog_c.send_msg(self.udp_req)
81 prog_c.delay(self.udp_keepalive * 1000) # delay is defined in usec
84 prog_s = ASTFProgram(stream=False)
85 # set the keepalive timer for UDP flows to not close udp session
86 # immediately after packet exchange
87 prog_c.set_keepalive_msg(self.udp_keepalive)
91 prog_s.send_msg(self.udp_res)
93 prog_s.delay(self.udp_keepalive * 1000) # delay is defined in usec
96 ip_gen_c = ASTFIPGenDist(
97 ip_range=[self.p1_src_start_ip, self.p1_src_end_ip],
100 ip_gen_s = ASTFIPGenDist(
101 ip_range=[self.p1_dst_start_ip, self.p1_dst_end_ip],
105 glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
106 dist_client=ip_gen_c,
111 s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
114 temp_c = ASTFTCPClientTemplate(
117 limit=1032192, # TODO: set via input parameter ?
120 temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
121 template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
123 return ip_gen, template, None
127 """Register this traffic profile to T-Rex.
129 Do not change this function.
131 :return: Traffic Profiles.
134 return TrafficProfile()