GPL/traffic_profiles/trex/trex-stl-2n-ethip4-ip4dst60000-udir.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 / IP /
  29  - Direction 0 --> 1:
  30    - Source IP address range:      10.0.0.1
  31    - Destination IP address range: 20.0.0.0 - 20.0.234.95
  32 """
  33
  34 from trex.stl.api import *
  35 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  36
  37
  38 class TrafficStreams(TrafficStreamsBaseClass):
  39     """Stream profile."""
  40
  41     def __init__(self):
  42         """Initialization and setting of streams' parameters."""
  43
  44         super(TrafficStreamsBaseClass, self).__init__()
  45
  46         # IPs used in packet headers.
  47         self.p1_src_start_ip = u"10.0.0.1"
  48         self.p1_dst_start_ip = u"20.0.0.0"
  49         self.p1_dst_end_ip = u"20.0.234.95"
  50
  51     def define_packets(self):
  52         """Defines the packets to be sent from the traffic generator.
  53
  54         Packet definition: | ETH | IP |
  55
  56         :returns: Packets to be sent from the traffic generator.
  57         :rtype: tuple
  58         """
  59
  60         # Direction 0 --> 1
  61         base_pkt_a = (
  62             Ether() /
  63             IP(
  64                 src=self.p1_src_start_ip,
  65                 dst=self.p1_dst_start_ip,
  66                 proto=61
  67             )
  68         )
  69         # Direction 1 --> 0
  70         base_pkt_b = (
  71             Ether()
  72         )
  73
  74         # Direction 0 --> 1
  75         vm1 = STLScVmRaw(
  76             [
  77                 STLVmFlowVar(
  78                     name=u"dst",
  79                     min_value=self.p1_dst_start_ip,
  80                     max_value=self.p1_dst_end_ip,
  81                     size=4,
  82                     op=u"inc"
  83                 ),
  84                 STLVmWrFlowVar(
  85                     fv_name=u"dst",
  86                     pkt_offset=u"IP.dst"
  87                 ),
  88                 STLVmFixIpv4(
  89                     offset=u"IP"
  90                 )
  91             ]
  92         )
  93         # Direction 1 --> 0
  94         vm2 = STLScVmRaw()
  95
  96         return base_pkt_a, base_pkt_b, vm1, vm2
  97
  98
  99 def register():
 100     """Register this traffic profile to T-rex.
 101
 102     Do not change this function.
 103
 104     :return: Traffic streams.
 105     :rtype: Object
 106     """
 107     return TrafficStreams()