GPL/traffic_profiles/trex/trex-stl-2n-ethip4udp-1u1p.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 / UDP
  28  - Direction 0 --> 1:
  29    - Source IP address range:      20.0.0.0
  30    - Destination IP address range: 30.0.0.0
  31    - Source UDP port range:        1024
  32    - Destination UDP port range:   1024
  33  - Direction 1 --> 0:
  34    - Source IP address range:      30.0.0.0
  35    - Destination IP address range: 200.0.0.0
  36    - Source UDP port range:        1024
  37    - Destination UDP port range:   1028
  38 """
  39
  40 from trex.stl.api import *
  41 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  42
  43
  44 class TrafficStreams(TrafficStreamsBaseClass):
  45     """Stream profile."""
  46
  47     def __init__(self):
  48         """Initialization and setting of streams' parameters."""
  49
  50         super(TrafficStreamsBaseClass, self).__init__()
  51
  52         # IPs used in packet headers.
  53         self.p1_src_ip = u"20.0.0.0"
  54         self.p1_dst_ip = u"30.0.0.0"
  55
  56         self.p2_src_ip = u"30.0.0.0"
  57         self.p2_dst_ip = u"200.0.0.0"
  58
  59         # UDP ports used in packet headers.
  60         self.p1_src_udp_port = 1024
  61         self.p1_dst_udp_port = 1024
  62
  63         self.p2_src_udp_port = 1024
  64         self.p2_dst_udp_port = 2048
  65
  66     def define_packets(self):
  67         """Defines the packets to be sent from the traffic generator.
  68
  69         Packet definition: | ETH | IP | UDP |
  70
  71         :returns: Packets to be sent from the traffic generator.
  72         :rtype: tuple
  73         """
  74
  75         # Direction 0 --> 1
  76         base_pkt_a = (
  77             Ether() /
  78             IP(
  79                 src=self.p1_src_ip,
  80                 dst=self.p1_dst_ip,
  81                 proto=17
  82             ) /
  83             UDP(
  84                 sport=self.p1_src_udp_port,
  85                 dport=self.p1_dst_udp_port
  86             )
  87         )
  88         # Direction 1 --> 0
  89         base_pkt_b = (
  90             Ether() /
  91             IP(
  92                 src=self.p2_src_ip,
  93                 dst=self.p2_dst_ip,
  94                 proto=17
  95             ) /
  96             UDP(
  97                 sport=self.p2_src_udp_port,
  98                 dport=self.p2_dst_udp_port
  99             )
 100         )
 101
 102         return base_pkt_a, base_pkt_b, None, None
 103
 104
 105 def register():
 106     """Register this traffic profile to T-rex.
 107
 108     Do not change this function.
 109
 110     :return: Traffic streams.
 111     :rtype: Object
 112     """
 113     return TrafficStreams()