GPL/traffic_profiles/trex/trex-stl-ethip4-ip4dst10000-2p.py

   1 # Copyright (c) 2023 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  - Three parallel bi-directional streams sent as W --> E and E --> W
  28    at the same time.
  29  - Packet: ETH / IP /
  30 """
  31
  32 from trex.stl.api import *
  33 from profile_trex_stateless_scale_class import TrafficStreamsScaleClass
  34
  35
  36 class TrafficStreams(TrafficStreamsScaleClass):
  37     """Stream profile."""
  38
  39     def __init__(self):
  40         """Initialization and setting of streams' parameters."""
  41
  42         super(TrafficStreamsScaleClass, self).__init__()
  43
  44         self.pkt_data = [
  45             # Direction W --> E:
  46             {
  47                 "src_start_ip": "10.0.0.1",
  48                 "dst_start_ip": "20.0.0.0",
  49                 "dst_end_ip": "20.0.39.15"
  50             },
  51             # Direction E --> W:
  52             {
  53                 "src_start_ip": "20.0.0.1",
  54                 "dst_start_ip": "10.0.0.0",
  55                 "dst_end_ip": "10.0.39.15"
  56             }
  57         ]
  58         self.pkt_base = []
  59         self.pkt_vm = []
  60
  61     def define_packets(self):
  62         """Defines the packets to be sent from the traffic generator.
  63
  64         Packet definition: | ETH | IP |
  65
  66         :returns: Base packets to be sent and transformation function.
  67         :rtype: tuple
  68         """
  69         for i in range(len(self.pkt_data)):
  70             self.pkt_base.append(
  71                 Ether() /
  72                 IP(
  73                     src=self.pkt_data[i]["src_start_ip"],
  74                     dst=self.pkt_data[i]["dst_start_ip"],
  75                     proto=61
  76                 )
  77             )
  78             self.pkt_vm.append(
  79                 STLScVmRaw(
  80                     [
  81                         STLVmFlowVar(
  82                             name="dst",
  83                             min_value=self.pkt_data[i]["dst_start_ip"],
  84                             max_value=self.pkt_data[i]["dst_end_ip"],
  85                             size=4,
  86                             op="inc"
  87                         ),
  88                         STLVmWrFlowVar(
  89                             fv_name="dst",
  90                             pkt_offset="IP.dst"
  91                         ),
  92                         STLVmFixIpv4(
  93                             offset="IP"
  94                         )
  95                     ]
  96                 )
  97             )
  98
  99         return self.pkt_base, self.pkt_vm
 100
 101
 102 def register():
 103     """Register this traffic profile to T-Rex.
 104
 105     Do not change this function.
 106
 107     :return: Traffic streams.
 108     :rtype: Object
 109     """
 110     return TrafficStreams()