GPL/traffic_profiles/trex/trex-stl-2n-ethip4udp-10u1000p-conc.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:      10.10.10.2 - 10.10.10.11
  31    - Destination IP address range: 20.20.20.2 - 20.20.20.11
  32    - Source UDP port range:        1001 - 2000
  33    - Destination UDP port range:   2001 - 3000
  34  - Direction 1 --> 0:
  35    - Source IP address range:      20.20.20.2 - 20.20.20.11
  36    - Destination IP address range: 10.10.10.2 - 10.10.10.11
  37    - Source UDP port range:        2001 - 3000
  38    - Destination UDP port range:   1001 - 2000
  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"10.10.10.2"
  55         self.p1_src_end_ip = u"10.10.10.11"
  56         self.p1_dst_start_ip = u"20.20.20.2"
  57         self.p1_dst_end_ip = u"20.20.20.11"
  58
  59         self.p2_src_start_ip = u"20.20.20.2"
  60         self.p2_src_end_ip = u"20.20.20.11"
  61         self.p2_dst_start_ip = u"10.10.10.2"
  62         self.p2_dst_end_ip = u"10.10.10.11"
  63
  64         # UDP ports used in packet headers.
  65         self.p1_src_start_udp_port = 1001
  66         self.p1_src_end_udp_port = 2000
  67         self.p1_dst_start_udp_port = 2001
  68         self.p1_dst_end_udp_port = 3000
  69
  70         self.p2_src_start_udp_port = 2001
  71         self.p2_src_end_udp_port = 3000
  72         self.p2_dst_start_udp_port = 1001
  73         self.p2_dst_end_udp_port = 2000
  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 = STLScVmRaw(
 113             [
 114                 STLVmTupleGen(
 115                     ip_min=self.p1_src_start_ip,
 116                     ip_max=self.p1_src_end_ip,
 117                     port_min=self.p1_src_start_udp_port,
 118                     port_max=self.p1_src_end_udp_port,
 119                     name=u"tuple1_src"
 120                 ),
 121                 STLVmTupleGen(
 122                     ip_min=self.p1_dst_start_ip,
 123                     ip_max=self.p1_dst_end_ip,
 124                     port_min=self.p1_dst_start_udp_port,
 125                     port_max=self.p1_dst_end_udp_port,
 126                     name=u"tuple1_dst"
 127                 ),
 128                 STLVmWrFlowVar(
 129                     fv_name=u"tuple1_src.ip",
 130                     pkt_offset=u"IP.src"
 131                 ),
 132                 STLVmWrFlowVar(
 133                     fv_name=u"tuple1_dst.ip",
 134                     pkt_offset=u"IP.dst"
 135                 ),
 136                 STLVmFixIpv4(
 137                     offset=u"IP"
 138                 ),
 139                 STLVmWrFlowVar(
 140                     fv_name=u"tuple1_src.port",
 141                     pkt_offset=u"UDP.sport"
 142                 ),
 143                 STLVmWrFlowVar(
 144                     fv_name=u"tuple1_dst.port",
 145                     pkt_offset=u"UDP.dport"
 146                 )
 147             ]
 148         )
 149         # Direction 0 --> 1
 150         vm2 = STLScVmRaw(
 151             [
 152                 STLVmTupleGen(
 153                     ip_min=self.p2_src_start_ip,
 154                     ip_max=self.p2_src_end_ip,
 155                     port_min=self.p2_src_start_udp_port,
 156                     port_max=self.p2_src_end_udp_port,
 157                     name=u"tuple2_src"
 158                 ),
 159                 STLVmTupleGen(
 160                     ip_min=self.p2_dst_start_ip,
 161                     ip_max=self.p2_dst_end_ip,
 162                     port_min=self.p2_dst_start_udp_port,
 163                     port_max=self.p2_dst_end_udp_port,
 164                     name=u"tuple2_dst"
 165                 ),
 166                 STLVmWrFlowVar(
 167                     fv_name=u"tuple2_src.ip",
 168                     pkt_offset=u"IP.src"
 169                 ),
 170                 STLVmWrFlowVar(
 171                     fv_name=u"tuple2_dst.ip",
 172                     pkt_offset=u"IP.dst"
 173                 ),
 174                 STLVmFixIpv4(
 175                     offset=u"IP"
 176                 ),
 177                 STLVmWrFlowVar(
 178                     fv_name=u"tuple2_src.port",
 179                     pkt_offset=u"UDP.sport"
 180                 ),
 181                 STLVmWrFlowVar(
 182                     fv_name=u"tuple2_dst.port",
 183                     pkt_offset=u"UDP.dport"
 184                 )
 185             ]
 186         )
 187
 188         return base_pkt_a, base_pkt_b, vm1, vm2
 189
 190
 191 def register():
 192     """Register this traffic profile to T-rex.
 193
 194     Do not change this function.
 195
 196     :return: Traffic streams.
 197     :rtype: Object
 198     """
 199     return TrafficStreams()