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