1 # Copyright (c) 2021 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 """Stream profile for T-rex traffic generator.
27 - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
28 - Packet: ETH / IP / UDP
30 - Source IP address range: 192.168.0.0 - 192.168.15.255
31 - Destination IP address range: 20.0.0.0
32 - Source UDP port range: 1024 - 1086
33 - Destination UDP port range: 1024
35 - Source IP address range: 20.0.0.0
36 - Destination IP address range: 68.142.68.0 - 68.142.68.3
37 - Source UDP port range: 1024
38 - Destination UDP port range: 1024 - 65535
41 from trex.stl.api import *
42 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
45 class TrafficStreams(TrafficStreamsBaseClass):
49 """Initialization and setting of streams' parameters."""
51 super(TrafficStreamsBaseClass, self).__init__()
53 # IPs used in packet headers.
54 self.p1_src_start_ip = u"192.168.0.0"
55 self.p1_src_end_ip = u"192.168.15.255"
56 self.p1_dst_start_ip = u"20.0.0.0"
57 self.p1_dst_end_ip = u"20.0.0.0"
59 self.p2_src_start_ip = u"20.0.0.0"
60 self.p2_src_end_ip = u"20.0.0.0"
61 self.p2_dst_start_ip = u"68.142.68.0"
62 self.p2_dst_end_ip = u"68.142.68.3"
64 # UDP ports used in packet headers.
65 self.p1_src_start_udp_port = 1024
66 self.p1_src_end_udp_port = 1086
67 self.p1_dst_start_udp_port = 1024
68 self.p1_dst_end_udp_port = 1024
70 self.p2_src_start_udp_port = 1024
71 self.p2_src_end_udp_port = 1024
72 self.p2_dst_start_udp_port = 1024
73 self.p2_dst_end_udp_port = 65535
75 def define_packets(self):
76 """Defines the packets to be sent from the traffic generator.
78 Packet definition: | ETH | IP | UDP |
80 :returns: Packets to be sent from the traffic generator.
88 src=self.p1_src_start_ip,
89 dst=self.p1_dst_start_ip,
93 sport=self.p1_src_start_udp_port,
94 dport=self.p1_dst_start_udp_port
101 src=self.p2_src_start_ip,
102 dst=self.p2_dst_start_ip,
106 sport=self.p2_src_start_udp_port,
107 dport=self.p2_dst_start_udp_port
114 min_value=self.p1_src_start_ip,
115 max_value=self.p1_src_end_ip,
119 vm1.var(name="sport",
120 min_value=self.p1_src_start_udp_port,
121 max_value=self.p1_src_end_udp_port,
125 min_value=self.p1_dst_start_ip,
126 max_value=self.p1_dst_end_ip,
129 vm1.var(name="dport",
130 min_value=self.p1_dst_start_udp_port,
131 max_value=self.p1_dst_end_udp_port,
134 vm1.write(fv_name="sIP", pkt_offset="IP.src")
135 vm1.write(fv_name="sport", pkt_offset="UDP.sport")
136 vm1.write(fv_name="dIP", pkt_offset="IP.dst")
137 vm1.write(fv_name="dport", pkt_offset="UDP.dport")
138 vm1.fix_chksum(offset='IP')
142 min_value=self.p2_src_start_ip,
143 max_value=self.p2_src_end_ip,
147 vm2.var(name="sport",
148 min_value=self.p2_src_start_udp_port,
149 max_value=self.p2_src_end_udp_port,
153 min_value=self.p2_dst_start_ip,
154 max_value=self.p2_dst_end_ip,
158 vm2.var(name="dport",
159 min_value=self.p2_dst_start_udp_port,
160 max_value=self.p2_dst_end_udp_port,
163 vm2.write(fv_name="sIP", pkt_offset="IP.src")
164 vm2.write(fv_name="sport", pkt_offset="UDP.sport")
165 vm2.write(fv_name="dIP", pkt_offset="IP.dst")
166 vm2.write(fv_name="dport", pkt_offset="UDP.dport")
167 vm2.fix_chksum(offset='IP')
169 return base_pkt_a, base_pkt_b, vm1, vm2
172 """Register this traffic profile to T-rex.
174 Do not change this function.
176 :return: Traffic streams.
179 return TrafficStreams()