GPL/traffic_profiles/trex/trex-stl-3n-ethip4-ip4dst1.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
  32  - Direction 1 --> 0:
  33    - Source IP address range:      20.0.0.1
  34    - Destination IP address range: 10.0.0.0
  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_ip = u"10.0.0.1"
  51         self.p1_dst_ip = u"20.0.0.0"
  52
  53         self.p2_src_ip = u"20.0.0.1"
  54         self.p2_dst_ip = u"10.0.0.0"
  55
  56     def define_packets(self):
  57         """Defines the packets to be sent from the traffic generator.
  58
  59         Packet definition: | ETH | IP |
  60
  61         :returns: Packets to be sent from the traffic generator.
  62         :rtype: tuple
  63         """
  64
  65         # Direction 0 --> 1
  66         base_pkt_a = (
  67             Ether() /
  68             IP(
  69                 src=self.p1_src_ip,
  70                 dst=self.p1_dst_ip,
  71                 proto=61
  72             )
  73         )
  74         # Direction 1 --> 0
  75         base_pkt_b = (
  76             Ether() /
  77             IP(
  78                 src=self.p2_src_ip,
  79                 dst=self.p2_dst_ip,
  80                 proto=61
  81             )
  82         )
  83
  84         return base_pkt_a, base_pkt_b, None, None
  85
  86
  87 def register():
  88     """Register this traffic profile to T-rex.
  89
  90     Do not change this function.
  91
  92     :return: Traffic streams.
  93     :rtype: Object
  94     """
  95     return TrafficStreams()