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