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