GPL/traffic_profiles/trex/trex-stl-ethip4udp-262144u63p.py

   1 # Copyright (c) 2021 Cisco and/or its affiliates.
   2 #
   3 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
   4 #
   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:
   9 #
  10 #     http://www.apache.org/licenses/LICENSE-2.0
  11 #     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
  12 #
  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
  16 # Apache 2.
  17 #
  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.
  23
  24 """Stream profile for T-rex traffic generator.
  25
  26 Stream profile:
  27  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
  28  - Packet: ETH / IP / UDP
  29  - Direction 0 --> 1:
  30    - Source IP address range:      172.16.0.0 - 172.19.255.255
  31    - Destination IP address range: 20.0.0.0
  32    - Source UDP port range:        1024 - 1086
  33    - Destination UDP port range:   1024
  34  - Direction 1 --> 0:
  35    - Source IP address range:      20.0.0.0
  36    - Destination IP address range: 68.142.68.0 - 68.142.68.255
  37    - Source UDP port range:        1024
  38    - Destination UDP port range:   1024 - 65535
  39 """
  40
  41 from trex.stl.api import *
  42 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  43
  44
  45 class TrafficStreams(TrafficStreamsBaseClass):
  46     """Stream profile."""
  47
  48     def __init__(self):
  49         """Initialization and setting of streams' parameters."""
  50
  51         super(TrafficStreamsBaseClass, self).__init__()
  52
  53         # IPs used in packet headers.
  54         self.p1_src_start_ip = u"172.16.0.0"
  55         self.p1_src_end_ip = u"172.19.255.255"
  56         self.p1_dst_start_ip = u"20.0.0.0"
  57         self.p1_dst_end_ip = u"20.0.0.0"
  58
  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.255"
  63
  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
  69
  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
  74
  75     def define_packets(self):
  76         """Defines the packets to be sent from the traffic generator.
  77
  78         Packet definition: | ETH | IP | UDP |
  79
  80         :returns: Packets to be sent from the traffic generator.
  81         :rtype: tuple
  82         """
  83
  84         # Direction 0 --> 1
  85         base_pkt_a = (
  86             Ether() /
  87             IP(
  88                 src=self.p1_src_start_ip,
  89                 dst=self.p1_dst_start_ip,
  90                 proto=17
  91             ) /
  92             UDP(
  93                 sport=self.p1_src_start_udp_port,
  94                 dport=self.p1_dst_start_udp_port
  95             )
  96         )
  97         # Direction 1 --> 0
  98         base_pkt_b = (
  99             Ether() /
 100             IP(
 101                 src=self.p2_src_start_ip,
 102                 dst=self.p2_dst_start_ip,
 103                 proto=17
 104             ) /
 105             UDP(
 106                 sport=self.p2_src_start_udp_port,
 107                 dport=self.p2_dst_start_udp_port
 108             )
 109         )
 110
 111         # Direction 0 --> 1
 112         vm1 = STLVM()
 113         vm1.var(name="sIP",
 114                 min_value=self.p1_src_start_ip,
 115                 max_value=self.p1_src_end_ip,
 116                 size=4,
 117                 op="inc",
 118                 next_var="sport")
 119         vm1.var(name="sport",
 120                 min_value=self.p1_src_start_udp_port,
 121                 max_value=self.p1_src_end_udp_port,
 122                 size=2,
 123                 op="inc")
 124         vm1.var(name="dIP",
 125                 min_value=self.p1_dst_start_ip,
 126                 max_value=self.p1_dst_end_ip,
 127                 size=4,
 128                 op="inc")
 129         vm1.var(name="dport",
 130                 min_value=self.p1_dst_start_udp_port,
 131                 max_value=self.p1_dst_end_udp_port,
 132                 size=2,
 133                 op="inc")
 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')
 139         # Direction 0 --> 1
 140         vm2 = STLVM()
 141         vm2.var(name="sIP",
 142                 min_value=self.p2_src_start_ip,
 143                 max_value=self.p2_src_end_ip,
 144                 size=4,
 145                 op="inc",
 146                 next_var="sport")
 147         vm2.var(name="sport",
 148                 min_value=self.p2_src_start_udp_port,
 149                 max_value=self.p2_src_end_udp_port,
 150                 size=2,
 151                 op="inc")
 152         vm2.var(name="dIP",
 153                 min_value=self.p2_dst_start_ip,
 154                 max_value=self.p2_dst_end_ip,
 155                 size=4,
 156                 op="inc",
 157                 next_var="dport")
 158         vm2.var(name="dport",
 159                 min_value=self.p2_dst_start_udp_port,
 160                 max_value=self.p2_dst_end_udp_port,
 161                 size=2,
 162                 op="inc")
 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')
 168
 169         return base_pkt_a, base_pkt_b, vm1, vm2
 170
 171 def register():
 172     """Register this traffic profile to T-rex.
 173
 174     Do not change this function.
 175
 176     :return: Traffic streams.
 177     :rtype: Object
 178     """
 179     return TrafficStreams()