GPL/traffic_profiles/trex/trex-stl-3n-ethip4udp-1u15p.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:      20.0.0.0
  30    - Destination IP address range: 12.0.0.2
  31    - Source UDP port range:        1024 - 1038
  32    - Destination UDP port range:   1024
  33  - Direction 1 --> 0:
  34    - Source IP address range:      12.0.0.2
  35    - Destination IP address range: 200.0.0.0
  36    - Source UDP port range:        1024
  37    - Destination UDP port range:   1024 - 1038
  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"20.0.0.0"
  54         self.p1_src_end_ip = u"20.0.0.0"
  55         self.p1_dst_start_ip = u"12.0.0.2"
  56
  57         self.p2_src_start_ip = u"12.0.0.2"
  58         self.p2_src_end_ip = u"12.0.0.2"
  59         self.p2_dst_start_ip = u"200.0.0.0"
  60
  61         # UDP ports used in packet headers.
  62         self.p1_src_start_udp_port = 1024
  63         self.p1_src_end_udp_port = 1038
  64         self.p1_dst_start_udp_port = 1024
  65
  66         self.p2_src_start_udp_port = 1024
  67         self.p2_dst_start_udp_port = 1024
  68         self.p2_dst_end_udp_port = 1038
  69
  70     def define_packets(self):
  71         """Defines the packets to be sent from the traffic generator.
  72
  73         Packet definition: | ETH | IP | UDP |
  74
  75         :returns: Packets to be sent from the traffic generator.
  76         :rtype: tuple
  77         """
  78
  79         # Direction 0 --> 1
  80         base_pkt_a = (
  81             Ether() /
  82             IP(
  83                 src=self.p1_src_start_ip,
  84                 dst=self.p1_dst_start_ip,
  85                 proto=17
  86             ) /
  87             UDP(
  88                 sport=self.p1_src_start_udp_port,
  89                 dport=self.p1_dst_start_udp_port
  90             )
  91         )
  92         # Direction 1 --> 0
  93         base_pkt_b = (
  94             Ether() /
  95             IP(
  96                 src=self.p2_src_start_ip,
  97                 dst=self.p2_dst_start_ip,
  98                 proto=17
  99             ) /
 100             UDP(
 101                 sport=self.p2_src_start_udp_port,
 102                 dport=self.p2_dst_start_udp_port
 103             )
 104         )
 105
 106         # Direction 0 --> 1
 107         vm1 = STLScVmRaw(
 108             [
 109                 STLVmFlowVar(
 110                     name=u"sport",
 111                     min_value=self.p1_src_start_udp_port,
 112                     max_value=self.p1_src_end_udp_port,
 113                     size=2,
 114                     op=u"inc"
 115                 ),
 116                 STLVmWrFlowVar(
 117                     fv_name=u"sport",
 118                     pkt_offset=u"UDP.sport"
 119                 )
 120             ]
 121         )
 122         # Direction 0 --> 1
 123         vm2 = STLScVmRaw(
 124             [
 125                 STLVmFlowVar(
 126                     name=u"dport",
 127                     min_value=self.p2_dst_start_udp_port,
 128                     max_value=self.p2_dst_end_udp_port,
 129                     size=2,
 130                     op=u"inc"
 131                 ),
 132                 STLVmWrFlowVar(
 133                     fv_name=u"dport",
 134                     pkt_offset=u"UDP.dport"
 135                 )
 136             ]
 137         )
 138
 139         return base_pkt_a, base_pkt_b, vm1, vm2
 140
 141
 142 def register():
 143     """Register this traffic profile to T-rex.
 144
 145     Do not change this function.
 146
 147     :return: Traffic streams.
 148     :rtype: Object
 149     """
 150     return TrafficStreams()