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