GPL/traffic_profiles/trex/trex-stl-ethip4-ip4src1000ip4dst1000.py

   1 # Copyright (c) 2023 Intel 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 /
  29  - Direction 0 --> 1:
  30    - Source IP address range:       10.0.0.0 - 10.3.231.0
  31    - Destination IP address range:  20.0.0.0 - 20.3.231.0
  32  - Direction 1 --> 0:
  33    - Source IP address range:       20.0.0.0 - 20.3.231.0
  34    - Destination IP address range:  10.0.0.0 - 10.3.231.0
  35 """
  36
  37 from trex.stl.api import *
  38 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  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"10.0.0.0"
  50         self.p1_src_end_ip = u"10.3.231.0"
  51
  52         self.p1_dst_start_ip = u"20.0.0.0"
  53         self.p1_dst_end_ip = u"20.3.231.0"
  54
  55         self.p2_src_start_ip = u"20.0.0.0"
  56         self.p2_src_end_ip = u"20.3.231.0"
  57
  58         self.p2_dst_start_ip = u"10.0.0.0"
  59         self.p2_dst_end_ip = u"10.3.231.0"
  60
  61     def define_packets(self):
  62         """Defines the packets to be sent from the traffic generator.
  63
  64         Packet definition: | ETH | IP |
  65
  66         :returns: Packets to be sent from the traffic generator.
  67         :rtype: tuple
  68         """
  69
  70         # Direction 0 --> 1
  71         base_pkt_a = (
  72             Ether() /
  73             IP(
  74               src=self.p1_src_start_ip,
  75               dst=self.p1_dst_start_ip,
  76               proto=61
  77             )
  78         )
  79         # Direction 1 --> 0
  80         base_pkt_b = (
  81             Ether() /
  82             IP(
  83                 src=self.p2_src_start_ip,
  84                 dst=self.p2_dst_start_ip,
  85                 proto=61
  86             )
  87         )
  88
  89         # Direction 0 --> 1
  90         vm1 = STLScVmRaw(
  91             [
  92                 STLVmFlowVar(
  93                     name=u"ip_src",
  94                     min_value=self.p1_src_start_ip,
  95                     max_value=self.p1_src_end_ip,
  96                     size=4,
  97                     step=256,
  98                     op=u"inc"
  99                 ),
 100                 STLVmWrFlowVar(
 101                     fv_name=u"ip_src",
 102                     pkt_offset=u"IP.src"
 103                 ),
 104                 STLVmFlowVar(
 105                     name=u"ip_dst",
 106                     min_value=self.p1_dst_start_ip,
 107                     max_value=self.p1_dst_end_ip,
 108                     size=4,
 109                     step=256,
 110                     op=u"inc"
 111                 ),
 112                 STLVmWrFlowVar(
 113                     fv_name=u"ip_dst",
 114                     pkt_offset=u"IP.dst"
 115                 ),
 116                 STLVmFixIpv4(
 117                     offset=u"IP"
 118                 )
 119             ]
 120         )
 121         # Direction 1 --> 0
 122         vm2 = STLScVmRaw(
 123             [
 124                 STLVmFlowVar(
 125                     name=u"ip_src",
 126                     min_value=self.p2_src_start_ip,
 127                     max_value=self.p2_src_end_ip,
 128                     size=4,
 129                     step=256,
 130                     op=u"inc"
 131                 ),
 132                 STLVmWrFlowVar(
 133                     fv_name=u"ip_src",
 134                     pkt_offset=u"IP.src"
 135                 ),
 136                 STLVmFlowVar(
 137                     name=u"ip_dst",
 138                     min_value=self.p2_dst_start_ip,
 139                     max_value=self.p2_dst_end_ip,
 140                     size=4,
 141                     step=256,
 142                     op=u"inc"
 143                 ),
 144                 STLVmWrFlowVar(
 145                     fv_name=u"ip_dst",
 146                     pkt_offset=u"IP.dst"
 147                 ),
 148                 STLVmFixIpv4(
 149                     offset=u"IP"
 150                 )
 151             ]
 152         )
 153
 154         return base_pkt_a, base_pkt_b, vm1, vm2
 155
 156
 157 def register():
 158     """Register this traffic profile to T-rex.
 159
 160     Do not change this function.
 161
 162     :returns: Traffic streams.
 163     :rtype: Object
 164     """
 165     return TrafficStreams()