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