GPL/traffic_profiles/trex/trex-stl-ethip6-ip6dst500000.py

   1 # Copyright (c) 2023 Intel and/or its affiliates.
   2 # Copyright (c) 2023 Cisco and/or its affiliates.
   3 #
   4 # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
   5 #
   6 # Licensed under the Apache License 2.0 or
   7 # GNU General Public License v2.0 or later;  you may not use this file
   8 # except in compliance with one of these Licenses. You
   9 # may obtain a copy of the Licenses at:
  10 #
  11 #     http://www.apache.org/licenses/LICENSE-2.0
  12 #     https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
  13 #
  14 # Note: If this file is linked with Scapy, which is GPLv2+, your use of it
  15 # must be under GPLv2+.  If at any point in the future it is no longer linked
  16 # with Scapy (or other GPLv2+ licensed software), you are free to choose
  17 # Apache 2.
  18 #
  19 # Unless required by applicable law or agreed to in writing, software
  20 # distributed under the License is distributed on an "AS IS" BASIS,
  21 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  22 # See the License for the specific language governing permissions and
  23 # limitations under the License.
  24
  25 """Stream profile for T-rex traffic generator.
  26
  27 Stream profile:
  28  - Two streams sent in directions 0 --> 1 and 1 --> 0 at the same time.
  29  - Packet: ETH / IPv6 /
  30  - Direction 0 --> 1:
  31    - Source IP address range:      2001:1::1
  32    - Destination IP address range: 2001:2::0 - 2001:2::7:a11f
  33  - Direction 1 --> 0:
  34    - Source IP address range:      2001:2::1
  35    - Destination IP address range: 2001:1::0 - 2001:1::7:a11f
  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         # IPs used in packet headers.
  51         self.p1_src_start_ip = u"2001:1::1"
  52         self.p1_dst_start_ip = u"2001:2::0"
  53         self.p1_dst_end_ip = u"2001:2::7:a11f"
  54
  55         self.p2_src_start_ip = u"2001:2::1"
  56         self.p2_dst_start_ip = u"2001:1::0"
  57         self.p2_dst_end_ip = u"2001:1::7:a11f"
  58
  59     def define_packets(self):
  60         """Defines the packets to be sent from the traffic generator.
  61
  62         Packet definition: | ETH | IPv6 |
  63
  64         :returns: Packets to be sent from the traffic generator.
  65         :rtype: tuple
  66         """
  67
  68         base_p1, count_p1 = self._get_start_end_ipv6(
  69             self.p1_dst_start_ip,
  70             self.p1_dst_end_ip
  71         )
  72         base_p2, count_p2 = self._get_start_end_ipv6(
  73             self.p2_dst_start_ip,
  74             self.p2_dst_end_ip
  75         )
  76
  77         # Direction 0 --> 1
  78         base_pkt_a = (
  79             Ether() /
  80             IPv6(
  81                 src=self.p1_src_start_ip,
  82                 dst=self.p1_dst_start_ip
  83             )
  84         )
  85         # Direction 1 --> 0
  86         base_pkt_b = (
  87             Ether() /
  88             IPv6(
  89                 src=self.p2_src_start_ip,
  90                 dst=self.p2_dst_start_ip
  91             )
  92         )
  93
  94         # Direction 0 --> 1
  95         vm1 = STLScVmRaw(
  96             [
  97                 STLVmFlowVar(
  98                     name=u"ipv6_dst",
  99                     min_value=base_p1,
 100                     max_value=base_p1 + count_p1,
 101                     size=8,
 102                     op=u"inc"
 103                 ),
 104                 STLVmWrFlowVar(
 105                     fv_name=u"ipv6_dst",
 106                     pkt_offset=u"IPv6.dst",
 107                     offset_fixup=8
 108                 )
 109             ]
 110         )
 111         # Direction 1 --> 0
 112         vm2 = STLScVmRaw(
 113             [
 114                 STLVmFlowVar(
 115                     name=u"ipv6_dst",
 116                     min_value=base_p2,
 117                     max_value=base_p2 + count_p2,
 118                     size=8,
 119                     op=u"inc"
 120                 ),
 121                 STLVmWrFlowVar(
 122                     fv_name=u"ipv6_dst",
 123                     pkt_offset=u"IPv6.dst",
 124                     offset_fixup=8
 125                 )
 126             ]
 127         )
 128
 129         return base_pkt_a, base_pkt_b, vm1, vm2
 130
 131
 132 def register():
 133     """Register this traffic profile to T-rex.
 134
 135     Do not change this function.
 136
 137     :return: Traffic streams.
 138     :rtype: Object
 139     """
 140     return TrafficStreams()