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

   1 # Copyright (c) 2023 Intel and/or its affiliates.
   2 # Copyright (c) 2023 Cisco and/or its affiliates.
   3 #
   4 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
   5 #
   6 # Licensed under the Apache License 2.0 or
   7 # GNU General Public License v2.0 or later;  you may not use this file
   8 # except in compliance with one of these Licenses. You
   9 # may obtain a copy of the Licenses at:
  10 #
  11 #     http://www.apache.org/licenses/LICENSE-2.0
  12 #     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
  13 #
  14 # Note: If this file is linked with Scapy, which is GPLv2+, your use of it
  15 # must be under GPLv2+.  If at any point in the future it is no longer linked
  16 # with Scapy (or other GPLv2+ licensed software), you are free to choose
  17 # Apache 2.
  18 #
  19 # Unless required by applicable law or agreed to in writing, software
  20 # distributed under the License is distributed on an "AS IS" BASIS,
  21 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  22 # See the License for the specific language governing permissions and
  23 # limitations under the License.
  24
  25 """Stream profile for T-rex traffic generator.
  26
  27 Stream profile:
  28  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
  29  - Packet: ETH / IP /
  30  - Direction 0 --> 1:
  31    - Source IP address range:      10.0.0.1
  32    - Destination IP address range: 20.0.0.0 - 20.7.161.31
  33  - Direction 1 --> 0:
  34    - Source IP address range:      20.0.0.1
  35    - Destination IP address range: 10.0.0.0 - 10.7.161.31
  36 """
  37
  38 from trex.stl.api import *
  39 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  40
  41
  42 class TrafficStreams(TrafficStreamsBaseClass):
  43     """Stream profile."""
  44
  45     def __init__(self):
  46         """Initialization and setting of streams' parameters."""
  47
  48         super(TrafficStreamsBaseClass, self).__init__()
  49
  50         # IPs used in packet headers.
  51         self.p1_src_start_ip = u"10.0.0.1"
  52         self.p1_dst_start_ip = u"20.0.0.0"
  53         self.p1_dst_end_ip = u"20.7.161.31"
  54
  55         self.p2_src_start_ip = u"20.0.0.1"
  56         self.p2_dst_start_ip = u"10.0.0.0"
  57         self.p2_dst_end_ip = u"10.7.161.31"
  58
  59     def define_packets(self):
  60         """Defines the packets to be sent from the traffic generator.
  61
  62         Packet definition: | ETH | IP |
  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=61
  75             )
  76         )
  77         # Direction 1 --> 0
  78         base_pkt_b = (
  79             Ether() /
  80             IP(
  81                 src=self.p2_src_start_ip,
  82                 dst=self.p2_dst_start_ip,
  83                 proto=61
  84             )
  85         )
  86
  87         # Direction 0 --> 1
  88         vm1 = STLScVmRaw(
  89             [
  90                 STLVmFlowVar(
  91                     name=u"dst",
  92                     min_value=self.p1_dst_start_ip,
  93                     max_value=self.p1_dst_end_ip,
  94                     size=4,
  95                     op=u"inc"
  96                 ),
  97                 STLVmWrFlowVar(
  98                     fv_name=u"dst",
  99                     pkt_offset=u"IP.dst"
 100                 ),
 101                 STLVmFixIpv4(
 102                     offset=u"IP"
 103                 )
 104             ]
 105         )
 106         # Direction 1 --> 0
 107         vm2 = STLScVmRaw(
 108             [
 109                 STLVmFlowVar(
 110                     name=u"dst",
 111                     min_value=self.p2_dst_start_ip,
 112                     max_value=self.p2_dst_end_ip,
 113                     size=4,
 114                     op=u"inc"
 115                 ),
 116                 STLVmWrFlowVar(
 117                     fv_name=u"dst",
 118                     pkt_offset=u"IP.dst"
 119                 ),
 120                 STLVmFixIpv4(
 121                     offset=u"IP"
 122                 )
 123             ]
 124         )
 125
 126         return base_pkt_a, base_pkt_b, vm1, vm2
 127
 128
 129 def register():
 130     """Register this traffic profile to T-rex.
 131
 132     Do not change this function.
 133
 134     :return: Traffic streams.
 135     :rtype: Object
 136     """
 137     return TrafficStreams()