GPL/traffic_profiles/trex/trex-stl-dot1qip4-vlan1ip4src254ip4dst254.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 / DOT1Q / IP /
  29  - Direction 0 --> 1:
  30    - VLAN range:                    100
  31    - Source IP address range:       10.10.10.1 - 10.10.10.254
  32    - Destination IP address range:  20.20.20.1 - 20.20.20.254
  33  - Direction 1 --> 0:
  34    - VLAN range:                    200
  35    - Source IP address range:       20.20.20.1 - 20.20.20.254
  36    - Destination IP address range:  10.10.10.1 - 10.10.10.254
  37 """
  38
  39 from trex.stl.api import *
  40 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  41
  42
  43 class TrafficStreams(TrafficStreamsBaseClass):
  44     """Stream profile."""
  45
  46     def __init__(self):
  47         """Initialization and setting of streams' parameters."""
  48
  49         super(TrafficStreamsBaseClass, self).__init__()
  50
  51         # VLAN IDs
  52         self.p1_vlan_start = 100
  53         self.p2_vlan_start = 200
  54
  55         # IPs used in packet headers.
  56         self.p1_src_start_ip = u"10.10.10.1"
  57         self.p1_src_end_ip = u"10.10.10.254"
  58
  59         self.p1_dst_start_ip = u"20.20.20.1"
  60         self.p1_dst_end_ip = u"20.20.20.254"
  61
  62         self.p2_src_start_ip = u"20.20.20.1"
  63         self.p2_src_end_ip = u"20.20.20.254"
  64
  65         self.p2_dst_start_ip = u"10.10.10.1"
  66         self.p2_dst_end_ip = u"10.10.10.254"
  67
  68     def define_packets(self):
  69         """Defines the packets to be sent from the traffic generator.
  70
  71         Packet definition: | ETH | DOT1Q | IP |
  72
  73         :returns: Packets to be sent from the traffic generator.
  74         :rtype: tuple
  75         """
  76
  77         # Direction 0 --> 1
  78         base_pkt_a = (
  79             Ether() /
  80             Dot1Q(
  81                 vlan=self.p1_vlan_start
  82             ) /
  83             IP(
  84                 src=self.p1_src_start_ip,
  85                 dst=self.p1_dst_start_ip,
  86                 proto=61
  87             )
  88         )
  89         # Direction 1 --> 0
  90         base_pkt_b = (
  91             Ether() /
  92             Dot1Q(
  93                 vlan=self.p2_vlan_start
  94             ) /
  95             IP(
  96                 src=self.p2_src_start_ip,
  97                 dst=self.p2_dst_start_ip,
  98                 proto=61
  99             )
 100         )
 101
 102         # Direction 0 --> 1
 103         vm1 = STLScVmRaw(
 104             [
 105                 STLVmFlowVar(
 106                     name=u"ip_src",
 107                     min_value=self.p1_src_start_ip,
 108                     max_value=self.p1_src_end_ip,
 109                     size=4,
 110                     op=u"random"
 111                 ),
 112                 STLVmWrFlowVar(
 113                     fv_name=u"ip_src",
 114                     pkt_offset=u"IP.src"
 115                 ),
 116                 STLVmFlowVar(
 117                     name=u"ip_dst",
 118                     min_value=self.p1_dst_start_ip,
 119                     max_value=self.p1_dst_end_ip,
 120                     size=4,
 121                     op=u"random"
 122                 ),
 123                 STLVmWrFlowVar(
 124                     fv_name=u"ip_dst",
 125                     pkt_offset=u"IP.dst"
 126                 ),
 127                 STLVmFixIpv4(
 128                     offset=u"IP"
 129                 )
 130             ]
 131         )
 132         # Direction 1 --> 0
 133         vm2 = STLScVmRaw(
 134             [
 135               STLVmFlowVar(
 136                     name=u"ip_src",
 137                     min_value=self.p2_src_start_ip,
 138                     max_value=self.p2_src_end_ip,
 139                     size=4,
 140                     op=u"random"
 141                 ),
 142                 STLVmWrFlowVar(
 143                     fv_name=u"ip_src",
 144                     pkt_offset=u"IP.src"
 145                 ),
 146                 STLVmFlowVar(
 147                     name=u"ip_dst",
 148                     min_value=self.p2_dst_start_ip,
 149                     max_value=self.p2_dst_end_ip,
 150                     size=4,
 151                     op=u"random"
 152                 ),
 153                 STLVmWrFlowVar(
 154                     fv_name=u"ip_dst",
 155                     pkt_offset=u"IP.dst"
 156                 ),
 157                 STLVmFixIpv4(
 158                     offset=u"IP"
 159                 )
 160             ]
 161         )
 162
 163         return base_pkt_a, base_pkt_b, vm1, vm2
 164
 165
 166 def register():
 167     """Register this traffic profile to T-rex.
 168
 169     Do not change this function.
 170
 171     :returns: Traffic streams.
 172     :rtype: Object
 173     """
 174     return TrafficStreams()