GPL/traffic_profiles/trex/trex-stl-ethip4udp-1024u63p-udir.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  - One stream sent in directions 0 --> 1.
  28  - Packet: ETH / IP / UDP
  29  - Direction 0 --> 1:
  30    - Source IP address range:      192.168.0.0 - 192.168.3.255
  31    - Destination IP address range: 20.0.0.0 - 20.0.3.255
  32    - Source UDP port range:        1024 - 1086
  33    - Destination UDP port range:   8080
  34 """
  35
  36 from trex.stl.api import *
  37 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  38
  39
  40 class TrafficStreams(TrafficStreamsBaseClass):
  41     """Stream profile."""
  42
  43     def __init__(self):
  44         """Initialization and setting of streams' parameters."""
  45
  46         super(TrafficStreamsBaseClass, self).__init__()
  47
  48         # IPs used in packet headers.
  49         self.p1_src_start_ip = u"192.168.0.0"
  50         self.p1_src_end_ip = u"192.168.3.255"
  51         self.p1_dst_start_ip = u"20.0.0.0"
  52         self.p1_dst_end_ip = u"20.0.3.255"
  53
  54         # UDP ports used in packet headers.
  55         self.p1_src_start_udp_port = 1024
  56         self.p1_src_end_udp_port = 1086
  57         self.p1_dst_start_udp_port = 8080
  58         self.p1_dst_end_udp_port = 8080
  59
  60     def define_packets(self):
  61         """Defines the packets to be sent from the traffic generator.
  62
  63         Packet definition: | ETH | IP | UDP |
  64
  65         :returns: Packets to be sent from the traffic generator.
  66         :rtype: tuple
  67         """
  68
  69         # Direction 0 --> 1
  70         base_pkt_a = (
  71             Ether() /
  72             IP(
  73                 src=self.p1_src_start_ip,
  74                 dst=self.p1_dst_start_ip,
  75                 proto=17
  76             ) /
  77             UDP(
  78                 sport=self.p1_src_start_udp_port,
  79                 dport=self.p1_dst_start_udp_port
  80             )
  81         )
  82
  83         base_pkt_b = (
  84             Ether()
  85         )
  86
  87         # Direction 0 --> 1
  88         vm1 = STLVM()
  89         vm1.var(name="sIP",
  90                 min_value=self.p1_src_start_ip,
  91                 max_value=self.p1_src_end_ip,
  92                 size=4,
  93                 op="inc",
  94                 next_var="sport")
  95         vm1.var(name="sport",
  96                 min_value=self.p1_src_start_udp_port,
  97                 max_value=self.p1_src_end_udp_port,
  98                 size=2,
  99                 op="inc")
 100         vm1.var(name="dIP",
 101                 min_value=self.p1_dst_start_ip,
 102                 max_value=self.p1_dst_end_ip,
 103                 size=4,
 104                 op="inc")
 105         vm1.var(name="dport",
 106                 min_value=self.p1_dst_start_udp_port,
 107                 max_value=self.p1_dst_end_udp_port,
 108                 size=2,
 109                 op="inc")
 110         vm1.write(fv_name="sIP", pkt_offset="IP.src")
 111         vm1.write(fv_name="sport", pkt_offset="UDP.sport")
 112         vm1.write(fv_name="dIP", pkt_offset="IP.dst")
 113         vm1.write(fv_name="dport", pkt_offset="UDP.dport")
 114         vm1.fix_chksum(offset='IP')
 115
 116         vm2 = STLVM()
 117
 118         return base_pkt_a, base_pkt_b, vm1, vm2
 119
 120 def register():
 121     """Register this traffic profile to T-rex.
 122
 123     Do not change this function.
 124
 125     :return: Traffic streams.
 126     :rtype: Object
 127     """
 128     return TrafficStreams()