GPL/traffic_profiles/trex/trex-stl-2n-ethip4udp-lb.py

   1 # Copyright (c) 2021 Intel 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  - Packet: ETH / IP / UDP
  28  - Direction 0 --> 1:
  29    - Source IP address range:      192.168.50.74 - 192.168.50.79
  30    - Destination IP address range: 90.1.2.1
  31  - Direction 1 --> 0:
  32    - Source IP address range:      192.168.60.74 - 192.168.60.79
  33    - Destination IP address range: 192.168.50.74 - 192.168.50.79
  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_start_ip = u"192.168.50.74"
  50         self.p1_src_end_ip = u"192.168.50.79"
  51         self.p1_dst_start_ip = u"90.1.2.1"
  52
  53         self.p2_src_start_ip = u"192.168.60.74"
  54         self.p2_src_end_ip = u"192.168.60.79"
  55         self.p2_dst_start_ip = u"192.168.50.74"
  56         self.p2_dst_end_ip = u"192.168.50.79"
  57
  58         # UDP ports used in packet headers.
  59         self.p1_src_udp_port = 63
  60         self.p1_dst_udp_port = 20000
  61
  62         self.p2_src_udp_port = 3307
  63         self.p2_dst_udp_port = 63
  64
  65     def define_packets(self):
  66         """Defines the packets to be sent from the traffic generator.
  67
  68         Packet definition: | ETH | IP | UDP
  69
  70         :returns: Packets to be sent from the traffic generator.
  71         :rtype: tuple
  72         """
  73
  74         # Direction 0 --> 1
  75         base_pkt_a = (
  76             Ether() /
  77             IP(
  78                 src=self.p1_src_start_ip,
  79                 dst=self.p1_dst_start_ip,
  80                 proto=17) /
  81             UDP(
  82                 sport=self.p1_src_udp_port,
  83                 dport=self.p1_dst_udp_port
  84              )
  85         )
  86         # Direction 1 --> 0
  87         base_pkt_b = (
  88             Ether() /
  89             IP(
  90                 src=self.p2_src_start_ip,
  91                 dst=self.p2_dst_start_ip,
  92                 proto=17
  93              ) /
  94             UDP(
  95                 sport=self.p2_src_udp_port,
  96                 dport=self.p2_dst_udp_port
  97              )
  98         )
  99
 100         # Direction 0 --> 1
 101         vm1 = STLScVmRaw(
 102             [
 103                 STLVmFlowVar(
 104                     name=u"src",
 105                     min_value=self.p1_src_start_ip,
 106                     max_value=self.p1_src_end_ip,
 107                     size=4,
 108                     op=u"inc"
 109                 ),
 110                 STLVmWrFlowVar(
 111                     fv_name=u"src",
 112                     pkt_offset=u"IP.src"
 113                 ),
 114                 STLVmFixIpv4(
 115                     offset=u"IP"
 116                 )
 117             ]
 118         )
 119         # Direction 1 --> 0
 120         vm2 = STLScVmRaw(
 121             [
 122                 STLVmFlowVar(
 123                     name=u"src",
 124                     min_value=self.p2_src_start_ip,
 125                     max_value=self.p2_src_end_ip,
 126                     size=4,
 127                     op=u"inc"
 128                 ),
 129                 STLVmWrFlowVar(
 130                     fv_name=u"src",
 131                     pkt_offset=u"IP.src"
 132                 ),
 133                 STLVmFlowVar(
 134                     name=u"dst",
 135                     min_value=self.p2_dst_start_ip,
 136                     max_value=self.p2_dst_end_ip,
 137                     size=4,
 138                     op=u"inc"
 139                 ),
 140                 STLVmWrFlowVar(
 141                     fv_name=u"dst",
 142                     pkt_offset=u"IP.dst"
 143                 ),
 144                 STLVmFixIpv4(
 145                     offset=u"IP"
 146                 )
 147             ]
 148         )
 149         return base_pkt_a, base_pkt_b, vm1, vm2
 150
 151
 152 def register():
 153     """Register this traffic profile to T-rex.
 154
 155     Do not change this function.
 156
 157     :return: Traffic streams.
 158     :rtype: Object
 159     """
 160     return TrafficStreams()