GPL/traffic_profiles/trex/trex-stl-3n-dot1qip4-vlan1kip4src254ip4dst254.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:                    1 - 1000
  31    - Source IP address range:       10.0.0.1 - 10.0.0.254
  32    - Destination IP address range:  20.0.0.1 - 20.0.0.254
  33  - Direction 1 --> 0:
  34    - VLAN range:                    1 - 1000
  35    - Source IP address range:       20.0.0.1 - 20.0.0.254
  36    - Destination IP address range:  10.0.0.1 - 10.0.0.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.vlans = 1000
  53
  54         self.p1_vlan_start = 1
  55         self.p1_vlan_end = self.p1_vlan_start + self.vlans - 1
  56
  57         self.p2_vlan_start = 1
  58         self.p2_vlan_end = self.p2_vlan_start + self.vlans - 1
  59
  60         # IPs used in packet headers.
  61         self.p1_src_start_ip = u"10.0.0.1"
  62         self.p1_src_end_ip = u"10.0.0.254"
  63
  64         self.p1_dst_start_ip = u"20.0.0.1"
  65         self.p1_dst_end_ip = u"20.0.0.254"
  66
  67         self.p2_src_start_ip = u"20.0.0.1"
  68         self.p2_src_end_ip = u"20.0.0.254"
  69
  70         self.p2_dst_start_ip = u"10.0.0.1"
  71         self.p2_dst_end_ip = u"10.0.0.254"
  72
  73     def define_packets(self):
  74         """Defines the packets to be sent from the traffic generator.
  75
  76         Packet definition: | ETH | DOT1Q | IP |
  77
  78         :returns: Packets to be sent from the traffic generator.
  79         :rtype: tuple
  80         """
  81
  82         # Direction 0 --> 1
  83         base_pkt_a = (
  84             Ether() /
  85             Dot1Q(
  86                 vlan=self.p1_vlan_start
  87             ) /
  88             IP(
  89                 src=self.p1_src_start_ip,
  90                 dst=self.p1_dst_start_ip,
  91                 proto=61
  92             )
  93         )
  94         # Direction 1 --> 0
  95         base_pkt_b = (
  96             Ether() /
  97             Dot1Q(
  98                 vlan=self.p2_vlan_start
  99             ) /
 100             IP(
 101                 src=self.p2_src_start_ip,
 102                 dst=self.p2_dst_start_ip,
 103                 proto=61
 104             )
 105         )
 106
 107         # Direction 0 --> 1
 108         vm1 = STLScVmRaw(
 109             [
 110                 STLVmFlowVar(
 111                     name=u"vlan",
 112                     min_value=self.p1_vlan_start,
 113                     max_value=self.p1_vlan_end,
 114                     size=2,
 115                     op=u"inc"
 116                 ),
 117                 STLVmWrFlowVar(
 118                     fv_name=u"vlan",
 119                     pkt_offset=u"Dot1Q.vlan"
 120                 ),
 121                 STLVmFlowVar(
 122                     name=u"ip_src",
 123                     min_value=self.p1_src_start_ip,
 124                     max_value=self.p1_src_end_ip,
 125                     size=4,
 126                     op=u"random"
 127                 ),
 128                 STLVmWrFlowVar(
 129                     fv_name=u"ip_src",
 130                     pkt_offset=u"IP.src"
 131                 ),
 132                 STLVmFlowVar(
 133                     name=u"ip_dst",
 134                     min_value=self.p1_dst_start_ip,
 135                     max_value=self.p1_dst_end_ip,
 136                     size=4,
 137                     op=u"random"
 138                 ),
 139                 STLVmWrFlowVar(
 140                     fv_name=u"ip_dst",
 141                     pkt_offset=u"IP.dst"
 142                 ),
 143                 STLVmFixIpv4(
 144                     offset=u"IP"
 145                 )
 146             ]
 147         )
 148         # Direction 1 --> 0
 149         vm2 = STLScVmRaw(
 150             [
 151                 STLVmFlowVar(
 152                     name=u"vlan",
 153                     min_value=self.p2_vlan_start,
 154                     max_value=self.p2_vlan_end,
 155                     size=2,
 156                     op=u"inc"
 157                 ),
 158                 STLVmWrFlowVar(
 159                     fv_name=u"vlan",
 160                     pkt_offset=u"Dot1Q.vlan"
 161                 ),
 162                 STLVmFlowVar(
 163                     name=u"ip_src",
 164                     min_value=self.p2_src_start_ip,
 165                     max_value=self.p2_src_end_ip,
 166                     size=4,
 167                     op=u"random"
 168                 ),
 169                 STLVmWrFlowVar(
 170                     fv_name=u"ip_src",
 171                     pkt_offset=u"IP.src"
 172                 ),
 173                 STLVmFlowVar(
 174                     name=u"ip_dst",
 175                     min_value=self.p2_dst_start_ip,
 176                     max_value=self.p2_dst_end_ip,
 177                     size=4,
 178                     op=u"random"
 179                 ),
 180                 STLVmWrFlowVar(
 181                     fv_name=u"ip_dst",
 182                     pkt_offset=u"IP.dst"
 183                 ),
 184                 STLVmFixIpv4(
 185                     offset=u"IP"
 186                 )
 187             ]
 188         )
 189
 190         return base_pkt_a, base_pkt_b, vm1, vm2
 191
 192
 193 def register():
 194     """Register this traffic profile to T-rex.
 195
 196     Do not change this function.
 197
 198     :returns: Traffic streams.
 199     :rtype: Object
 200     """
 201     return TrafficStreams()