GPL/traffic_profiles/trex/trex-stl-ethip4udp-1024u63p-udir.py

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