GPL/traffic_profiles/trex/trex-stl-2n-ethip4udp-10u1000p-conc.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  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
  27  - Packet: ETH / IP / UDP
  28  - Direction 0 --> 1:
  29    - Source IP address range:      10.10.10.2 - 10.10.10.11
  30    - Destination IP address range: 20.20.20.2 - 20.20.20.11
  31    - Source UDP port range:        1001 - 2000
  32    - Destination UDP port range:   2001 - 3000
  33  - Direction 1 --> 0:
  34    - Source IP address range:      20.20.20.2 - 20.20.20.11
  35    - Destination IP address range: 10.10.10.2 - 10.10.10.11
  36    - Source UDP port range:        2001 - 3000
  37    - Destination UDP port range:   1001 - 2000
  38 """
  39
  40 from trex.stl.api import *
  41 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  42
  43
  44 class TrafficStreams(TrafficStreamsBaseClass):
  45     """Stream profile."""
  46
  47     def __init__(self):
  48         """Initialization and setting of streams' parameters."""
  49
  50         super(TrafficStreamsBaseClass, self).__init__()
  51
  52         # IPs used in packet headers.
  53         self.p1_src_start_ip = u"10.10.10.2"
  54         self.p1_src_end_ip = u"10.10.10.11"
  55         self.p1_dst_start_ip = u"20.20.20.2"
  56         self.p1_dst_end_ip = u"20.20.20.11"
  57
  58         self.p2_src_start_ip = u"20.20.20.2"
  59         self.p2_src_end_ip = u"20.20.20.11"
  60         self.p2_dst_start_ip = u"10.10.10.2"
  61         self.p2_dst_end_ip = u"10.10.10.11"
  62
  63         # UDP ports used in packet headers.
  64         self.p1_src_start_udp_port = 1001
  65         self.p1_src_end_udp_port = 2000
  66         self.p1_dst_start_udp_port = 2001
  67         self.p1_dst_end_udp_port = 3000
  68
  69         self.p2_src_start_udp_port = 2001
  70         self.p2_src_end_udp_port = 3000
  71         self.p2_dst_start_udp_port = 1001
  72         self.p2_dst_end_udp_port = 2000
  73
  74     def define_packets(self):
  75         """Defines the packets to be sent from the traffic generator.
  76
  77         Packet definition: | ETH | IP | UDP |
  78
  79         :returns: Packets to be sent from the traffic generator.
  80         :rtype: tuple
  81         """
  82
  83         # Direction 0 --> 1
  84         base_pkt_a = (
  85             Ether() /
  86             IP(
  87                 src=self.p1_src_start_ip,
  88                 dst=self.p1_dst_start_ip,
  89                 proto=17
  90             ) /
  91             UDP(
  92                 sport=self.p1_src_start_udp_port,
  93                 dport=self.p1_dst_start_udp_port
  94             )
  95         )
  96         # Direction 1 --> 0
  97         base_pkt_b = (
  98             Ether() /
  99             IP(
 100                   src=self.p2_src_start_ip,
 101                   dst=self.p2_dst_start_ip,
 102                   proto=17
 103             ) /
 104             UDP(
 105                 sport=self.p2_src_start_udp_port,
 106                 dport=self.p2_dst_start_udp_port
 107             )
 108         )
 109
 110         # Direction 0 --> 1
 111         vm1 = STLScVmRaw(
 112             [
 113                 STLVmTupleGen(
 114                     ip_min=self.p1_src_start_ip,
 115                     ip_max=self.p1_src_end_ip,
 116                     port_min=self.p1_src_start_udp_port,
 117                     port_max=self.p1_src_end_udp_port,
 118                     name=u"tuple1_src"
 119                 ),
 120                 STLVmTupleGen(
 121                     ip_min=self.p1_dst_start_ip,
 122                     ip_max=self.p1_dst_end_ip,
 123                     port_min=self.p1_dst_start_udp_port,
 124                     port_max=self.p1_dst_end_udp_port,
 125                     name=u"tuple1_dst"
 126                 ),
 127                 STLVmWrFlowVar(
 128                     fv_name=u"tuple1_src.ip",
 129                     pkt_offset=u"IP.src"
 130                 ),
 131                 STLVmWrFlowVar(
 132                     fv_name=u"tuple1_dst.ip",
 133                     pkt_offset=u"IP.dst"
 134                 ),
 135                 STLVmFixIpv4(
 136                     offset=u"IP"
 137                 ),
 138                 STLVmWrFlowVar(
 139                     fv_name=u"tuple1_src.port",
 140                     pkt_offset=u"UDP.sport"
 141                 ),
 142                 STLVmWrFlowVar(
 143                     fv_name=u"tuple1_dst.port",
 144                     pkt_offset=u"UDP.dport"
 145                 )
 146             ]
 147         )
 148         # Direction 0 --> 1
 149         vm2 = STLScVmRaw(
 150             [
 151                 STLVmTupleGen(
 152                     ip_min=self.p2_src_start_ip,
 153                     ip_max=self.p2_src_end_ip,
 154                     port_min=self.p2_src_start_udp_port,
 155                     port_max=self.p2_src_end_udp_port,
 156                     name=u"tuple2_src"
 157                 ),
 158                 STLVmTupleGen(
 159                     ip_min=self.p2_dst_start_ip,
 160                     ip_max=self.p2_dst_end_ip,
 161                     port_min=self.p2_dst_start_udp_port,
 162                     port_max=self.p2_dst_end_udp_port,
 163                     name=u"tuple2_dst"
 164                 ),
 165                 STLVmWrFlowVar(
 166                     fv_name=u"tuple2_src.ip",
 167                     pkt_offset=u"IP.src"
 168                 ),
 169                 STLVmWrFlowVar(
 170                     fv_name=u"tuple2_dst.ip",
 171                     pkt_offset=u"IP.dst"
 172                 ),
 173                 STLVmFixIpv4(
 174                     offset=u"IP"
 175                 ),
 176                 STLVmWrFlowVar(
 177                     fv_name=u"tuple2_src.port",
 178                     pkt_offset=u"UDP.sport"
 179                 ),
 180                 STLVmWrFlowVar(
 181                     fv_name=u"tuple2_dst.port",
 182                     pkt_offset=u"UDP.dport"
 183                 )
 184             ]
 185         )
 186
 187         return base_pkt_a, base_pkt_b, vm1, vm2
 188
 189
 190 def register():
 191     """Register this traffic profile to T-rex.
 192
 193     Do not change this function.
 194
 195     :return: Traffic streams.
 196     :rtype: Object
 197     """
 198     return TrafficStreams()