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