GPL/traffic_profiles/trex/trex-stl-3n-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:                    1
  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
  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.p1_vlan_start = 1
  53
  54         self.p2_vlan_start = 1
  55
  56
  57         # IPs used in packet headers.
  58         self.p1_src_start_ip = u"10.0.0.1"
  59         self.p1_src_end_ip = u"10.0.0.254"
  60
  61         self.p1_dst_start_ip = u"20.0.0.1"
  62         self.p1_dst_end_ip = u"20.0.0.254"
  63
  64         self.p2_src_start_ip = u"20.0.0.1"
  65         self.p2_src_end_ip = u"20.0.0.254"
  66
  67         self.p2_dst_start_ip = u"10.0.0.1"
  68         self.p2_dst_end_ip = u"10.0.0.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             Dot1Q(
  83               vlan=self.p1_vlan_start
  84             ) /
  85             IP(
  86               src=self.p1_src_start_ip,
  87               dst=self.p1_dst_start_ip,
  88               proto=61
  89             )
  90         )
  91         # Direction 1 --> 0
  92         base_pkt_b = (
  93             Ether() /
  94             Dot1Q(
  95                 vlan=self.p2_vlan_start
  96             ) /
  97             IP(
  98                 src=self.p2_src_start_ip,
  99                 dst=self.p2_dst_start_ip,
 100                 proto=61
 101             )
 102         )
 103
 104         # Direction 0 --> 1
 105         vm1 = STLScVmRaw(
 106             [
 107                 STLVmFlowVar(
 108                     name=u"ip_src",
 109                     min_value=self.p1_src_start_ip,
 110                     max_value=self.p1_src_end_ip,
 111                     size=4,
 112                     op=u"random"
 113                 ),
 114                 STLVmWrFlowVar(
 115                     fv_name=u"ip_src",
 116                     pkt_offset=u"IP.src"
 117                 ),
 118                 STLVmFlowVar(
 119                     name=u"ip_dst",
 120                     min_value=self.p1_dst_start_ip,
 121                     max_value=self.p1_dst_end_ip,
 122                     size=4,
 123                     op=u"random"
 124                 ),
 125                 STLVmWrFlowVar(
 126                     fv_name=u"ip_dst",
 127                     pkt_offset=u"IP.dst"
 128                 ),
 129                 STLVmFixIpv4(
 130                     offset=u"IP"
 131                 )
 132             ]
 133         )
 134         # Direction 1 --> 0
 135         vm2 = STLScVmRaw(
 136             [
 137                 STLVmFlowVar(
 138                     name=u"ip_src",
 139                     min_value=self.p2_src_start_ip,
 140                     max_value=self.p2_src_end_ip,
 141                     size=4,
 142                     op=u"random"
 143                 ),
 144                 STLVmWrFlowVar(
 145                     fv_name=u"ip_src",
 146                     pkt_offset=u"IP.src"
 147                 ),
 148                 STLVmFlowVar(
 149                     name=u"ip_dst",
 150                     min_value=self.p2_dst_start_ip,
 151                     max_value=self.p2_dst_end_ip,
 152                     size=4,
 153                     op=u"random"
 154                 ),
 155                 STLVmWrFlowVar(
 156                     fv_name=u"ip_dst",
 157                     pkt_offset=u"IP.dst"
 158                 ),
 159                 STLVmFixIpv4(
 160                     offset=u"IP"
 161                 )
 162             ]
 163         )
 164
 165         return base_pkt_a, base_pkt_b, vm1, vm2
 166
 167
 168 def register():
 169     """Register this traffic profile to T-rex.
 170
 171     Do not change this function.
 172
 173     :returns: Traffic streams.
 174     :rtype: Object
 175     """
 176     return TrafficStreams()