1 # Copyright (c) 2020 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 Apache 2.
17 # Unless required by applicable law or agreed to in writing, software
18 # distributed under the License is distributed on an "AS IS" BASIS,
19 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 # See the License for the specific language governing permissions and
21 # limitations under the License.
23 """Traffic profile for T-rex advanced stateful (astf) traffic generator.
26 - Two streams sent in directions 0 --> 1 (client -> server, requests) and
27 1 --> 0 (server -> client, responses) at the same time.
28 - Packet: ETH / IP / UDP
30 - Source IP address range: 192.168.0.0 - 192.168.63.255
31 - Destination IP address range: 20.0.0.0 - 20.0.63.255
33 - Source IP address range: destination IP address from packet received
35 - Destination IP address range: source IP address from packet received
38 This is a profile for CPS tests, it only sets up UDP session.
39 No delays, no data transfer.
40 Keepalive mechanism cannot be disabled, so it is at least set to long waits.
43 from trex.astf.api import *
45 from profile_trex_astf_base_class import TrafficProfileBaseClass
48 class TrafficProfile(TrafficProfileBaseClass):
49 """Traffic profile."""
52 """Initialization and setting of profile parameters."""
54 super(TrafficProfileBaseClass, self).__init__()
56 # IPs used in packet headers.
57 self.p1_src_start_ip = u"192.168.0.0"
58 self.p1_src_end_ip = u"192.168.63.255"
59 self.p1_dst_start_ip = u"20.0.0.0"
60 self.p1_dst_end_ip = u"20.0.63.255"
67 self.headers_size = 42 # 14B l2 + 20B ipv4 + 8B udp
69 # No need to set keepalive, both programs end just after start&send.
71 def define_profile(self):
72 """Define profile to be used by advanced stateful traffic generator.
74 This method MUST return:
75 return ip_gen, templates, None
77 :returns: IP generator and profile templates ASTFProfile().
80 self.udp_req += self._gen_padding(self.headers_size + len(self.udp_req))
81 self.udp_res += self._gen_padding(self.headers_size + len(self.udp_res))
84 prog_c = ASTFProgram(stream=False)
86 prog_c.send_msg(self.udp_req)
87 # No need to process the response, seeing L2 counter is enough.
88 # Client program can end here.
91 prog_s = ASTFProgram(stream=False)
92 # When server instance is created means REQ is visible in L2 counter.
93 # No need to receive explicitly?
95 prog_s.send_msg(self.udp_res)
96 # Server program can end here.
99 ip_gen_c = ASTFIPGenDist(
100 ip_range=[self.p1_src_start_ip, self.p1_src_end_ip],
103 ip_gen_s = ASTFIPGenDist(
104 ip_range=[self.p1_dst_start_ip, self.p1_dst_end_ip],
108 glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
109 dist_client=ip_gen_c,
114 s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
117 temp_c = ASTFTCPClientTemplate(
120 limit=1032192, # TODO: set via input parameter ?
123 temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
124 template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
126 return ip_gen, template, None
130 """Register this traffic profile to T-Rex.
132 Do not change this function.
134 :return: Traffic Profiles.
137 return TrafficProfile()