GPL/traffic_profiles/trex/trex-stl-3n-dot1qip4-vlan1ip4src254ip4dst254.py

   1 # Copyright (c) 2020 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 Apache 2.
  16 #
  17 # Unless required by applicable law or agreed to in writing, software
  18 # distributed under the License is distributed on an "AS IS" BASIS,
  19 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20 # See the License for the specific language governing permissions and
  21 # limitations under the License.
  22
  23 """Stream profile for T-rex traffic generator.
  24
  25 Stream profile:
  26  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
  27  - Packet: ETH / DOT1Q / IP /
  28  - Direction 0 --> 1:
  29    - VLAN range:                    1
  30    - Source IP address range:       10.0.0.1 - 10.0.0.254
  31    - Destination IP address range:  20.0.0.1 - 20.0.0.254
  32  - Direction 1 --> 0:
  33    - VLAN range:                    1
  34    - Source IP address range:       20.0.0.1 - 20.0.0.254
  35    - Destination IP address range:  10.0.0.1 - 10.0.0.254
  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         # VLAN IDs
  51         self.p1_vlan_start = 1
  52
  53         self.p2_vlan_start = 1
  54
  55
  56         # IPs used in packet headers.
  57         self.p1_src_start_ip = u"10.0.0.1"
  58         self.p1_src_end_ip = u"10.0.0.254"
  59
  60         self.p1_dst_start_ip = u"20.0.0.1"
  61         self.p1_dst_end_ip = u"20.0.0.254"
  62
  63         self.p2_src_start_ip = u"20.0.0.1"
  64         self.p2_src_end_ip = u"20.0.0.254"
  65
  66         self.p2_dst_start_ip = u"10.0.0.1"
  67         self.p2_dst_end_ip = u"10.0.0.254"
  68
  69     def define_packets(self):
  70         """Defines the packets to be sent from the traffic generator.
  71
  72         Packet definition: | ETH | DOT1Q | IP |
  73
  74         :returns: Packets to be sent from the traffic generator.
  75         :rtype: tuple
  76         """
  77
  78         # Direction 0 --> 1
  79         base_pkt_a = (
  80             Ether() /
  81             Dot1Q(
  82               vlan=self.p1_vlan_start
  83             ) /
  84             IP(
  85               src=self.p1_src_start_ip,
  86               dst=self.p1_dst_start_ip,
  87               proto=61
  88             )
  89         )
  90         # Direction 1 --> 0
  91         base_pkt_b = (
  92             Ether() /
  93             Dot1Q(
  94                 vlan=self.p2_vlan_start
  95             ) /
  96             IP(
  97                 src=self.p2_src_start_ip,
  98                 dst=self.p2_dst_start_ip,
  99                 proto=61
 100             )
 101         )
 102
 103         # Direction 0 --> 1
 104         vm1 = STLScVmRaw(
 105             [
 106                 STLVmFlowVar(
 107                     name=u"ip_src",
 108                     min_value=self.p1_src_start_ip,
 109                     max_value=self.p1_src_end_ip,
 110                     size=4,
 111                     op=u"random"
 112                 ),
 113                 STLVmWrFlowVar(
 114                     fv_name=u"ip_src",
 115                     pkt_offset=u"IP.src"
 116                 ),
 117                 STLVmFlowVar(
 118                     name=u"ip_dst",
 119                     min_value=self.p1_dst_start_ip,
 120                     max_value=self.p1_dst_end_ip,
 121                     size=4,
 122                     op=u"random"
 123                 ),
 124                 STLVmWrFlowVar(
 125                     fv_name=u"ip_dst",
 126                     pkt_offset=u"IP.dst"
 127                 ),
 128                 STLVmFixIpv4(
 129                     offset=u"IP"
 130                 )
 131             ]
 132         )
 133         # Direction 1 --> 0
 134         vm2 = STLScVmRaw(
 135             [
 136                 STLVmFlowVar(
 137                     name=u"ip_src",
 138                     min_value=self.p2_src_start_ip,
 139                     max_value=self.p2_src_end_ip,
 140                     size=4,
 141                     op=u"random"
 142                 ),
 143                 STLVmWrFlowVar(
 144                     fv_name=u"ip_src",
 145                     pkt_offset=u"IP.src"
 146                 ),
 147                 STLVmFlowVar(
 148                     name=u"ip_dst",
 149                     min_value=self.p2_dst_start_ip,
 150                     max_value=self.p2_dst_end_ip,
 151                     size=4,
 152                     op=u"random"
 153                 ),
 154                 STLVmWrFlowVar(
 155                     fv_name=u"ip_dst",
 156                     pkt_offset=u"IP.dst"
 157                 ),
 158                 STLVmFixIpv4(
 159                     offset=u"IP"
 160                 )
 161             ]
 162         )
 163
 164         return base_pkt_a, base_pkt_b, vm1, vm2
 165
 166
 167 def register():
 168     """Register this traffic profile to T-rex.
 169
 170     Do not change this function.
 171
 172     :returns: Traffic streams.
 173     :rtype: Object
 174     """
 175     return TrafficStreams()