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