GPL/traffic_profiles/trex/trex-stl-3n-ethip4-ip4dst1.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  - Packet: ETH / IP /
  28  - Direction 0 --> 1:
  29    - Source IP address range:      10.0.0.1
  30    - Destination IP address range: 20.0.0.0
  31  - Direction 1 --> 0:
  32    - Source IP address range:      20.0.0.1
  33    - Destination IP address range: 10.0.0.0
  34 """
  35
  36 from trex.stl.api import *
  37 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  38
  39
  40 class TrafficStreams(TrafficStreamsBaseClass):
  41     """Stream profile."""
  42
  43     def __init__(self):
  44         """Initialization and setting of streams' parameters."""
  45
  46         super(TrafficStreamsBaseClass, self).__init__()
  47
  48         # IPs used in packet headers.
  49         self.p1_src_ip = u"10.0.0.1"
  50         self.p1_dst_ip = u"20.0.0.0"
  51
  52         self.p2_src_ip = u"20.0.0.1"
  53         self.p2_dst_ip = u"10.0.0.0"
  54
  55     def define_packets(self):
  56         """Defines the packets to be sent from the traffic generator.
  57
  58         Packet definition: | ETH | IP |
  59
  60         :returns: Packets to be sent from the traffic generator.
  61         :rtype: tuple
  62         """
  63
  64         # Direction 0 --> 1
  65         base_pkt_a = (
  66             Ether() /
  67             IP(
  68                 src=self.p1_src_ip,
  69                 dst=self.p1_dst_ip,
  70                 proto=61
  71             )
  72         )
  73         # Direction 1 --> 0
  74         base_pkt_b = (
  75             Ether() /
  76             IP(
  77                 src=self.p2_src_ip,
  78                 dst=self.p2_dst_ip,
  79                 proto=61
  80             )
  81         )
  82
  83         return base_pkt_a, base_pkt_b, None, None
  84
  85
  86 def register():
  87     """Register this traffic profile to T-rex.
  88
  89     Do not change this function.
  90
  91     :return: Traffic streams.
  92     :rtype: Object
  93     """
  94     return TrafficStreams()