1 # Copyright (c) 2022 Cisco and/or its affiliates.
3 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
5 # Licensed under the Apache License 2.0 or
6 # GNU General Public License v2.0 or later; you may not use this file
7 # except in compliance with one of these Licenses. You
8 # may obtain a copy of the Licenses at:
10 # http://www.apache.org/licenses/LICENSE-2.0
11 # https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
13 # Note: If this file is linked with Scapy, which is GPLv2+, your use of it
14 # must be under GPLv2+. If at any point in the future it is no longer linked
15 # with Scapy (or other GPLv2+ licensed software), you are free to choose
18 # Unless required by applicable law or agreed to in writing, software
19 # distributed under the License is distributed on an "AS IS" BASIS,
20 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 # See the License for the specific language governing permissions and
22 # limitations under the License.
24 """Traffic profile for T-rex advanced stateful (astf) traffic generator.
27 - Two streams sent in directions 0 --> 1 (client -> server, requests) and
28 1 --> 0 (server -> client, responses) at the same time.
29 - Packet: ETH / IP / TCP
31 - Source IP address range: 192.168.0.0 - 192.168.255.255
32 - Destination IP address range: 20.0.0.0 - 20.0.255.255
34 - Source IP address range: destination IP address from packet received
36 - Destination IP address range: source IP address from packet received
39 This is a profile for PPS tests, it combines TCP connect and data transfer.
40 No delays, server response waits for full request.
43 from trex.astf.api import *
44 from profile_trex_astf_base_class import TrafficProfileBaseClass
47 class TrafficProfile(TrafficProfileBaseClass):
48 """Traffic profile."""
50 def define_profile(self):
51 """Define profile to be used by advanced stateful traffic generator.
53 This method MUST return:
55 return ip_gen, templates, None
57 :returns: IP generator and profile templates for ASTFProfile().
60 # IPs used in packet headers.
61 p1_src_start_ip = u"192.168.0.0"
62 p1_src_end_ip = u"192.168.255.255"
63 p1_dst_start_ip = u"20.0.0.0"
64 p1_dst_end_ip = u"20.0.255.255"
66 # Headers length, not sure why TRex needs 32B for segment header.
67 real_headers_size = 70 # 18B L2 + 20B IPv4 + 32B TCP.
68 trex_headers_size = real_headers_size - 12 # As if TCP header is 20B.
69 trex_mss = self.framesize - trex_headers_size
70 real_mss = trex_mss - 12 # TRex honors segment header+data limit.
71 data_size = self.n_data_frames * real_mss
74 prog_c = ASTFProgram()
76 prog_c.set_var(u"var1", self.n_data_frames)
77 prog_c.set_label(u"a1:")
78 prog_c.send(u"1" * real_mss)
80 prog_c.jmp_nz(u"var1", u"a1:")
83 prog_s = ASTFProgram()
85 prog_s.set_var(u"var2", self.n_data_frames)
86 prog_s.set_label(u"a2:")
88 prog_s.send(u"1" * real_mss)
89 prog_s.jmp_nz(u"var2", u"a2:")
92 ip_gen_c = ASTFIPGenDist(
93 ip_range=[p1_src_start_ip, p1_src_end_ip],
96 ip_gen_s = ASTFIPGenDist(
97 ip_range=[p1_dst_start_ip, p1_dst_end_ip],
101 glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
102 dist_client=ip_gen_c,
103 dist_server=ip_gen_s,
107 s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
110 temp_c = ASTFTCPClientTemplate(
113 limit=4128768, # TODO: set via input parameter
116 temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
117 template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
119 globinfo = ASTFGlobalInfo()
120 # Ensure correct data frame size.
121 globinfo.tcp.mss = trex_mss
122 globinfo.tcp.txbufsize = trex_mss
123 globinfo.tcp.rxbufsize = trex_mss
125 default_c_glob_info=globinfo,
126 default_s_glob_info=globinfo,
129 return ip_gen, template, kwargs
133 """Register this traffic profile to T-Rex.
135 Do not change this function.
137 :return: Traffic Profiles.
140 return TrafficProfile()