GPL/traffic_profiles/trex/trex-stl-2n3n-ethip4-ip4src254-10c1n.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 /
  29  - Direction 0 --> 1:
  30    - Destination MAC address: 52:54:00:00:nf_id:01
  31    - Source IP address range:      10.10.10.1 - 10.10.10.254
  32    - Destination IP address range: 20.20.20.1
  33  - Direction 1 --> 0:
  34    - Destination MAC address: 52:54:00:00:nf_id:02
  35    - Source IP address range:      20.20.20.1 - 20.20.20.254
  36    - Destination IP address range: 10.10.10.1
  37 """
  38
  39 from trex.stl.api import *
  40 from profile_trex_stateless_base_class import TrafficStreamsBaseClass
  41
  42
  43 class TrafficStreams(TrafficStreamsBaseClass):
  44     """Stream profile."""
  45
  46     def __init__(self):
  47         """Initialization and setting of streams' parameters."""
  48
  49         super(TrafficStreamsBaseClass, self).__init__()
  50
  51         # Service density parameters.
  52         self.nf_chains = 10
  53         self.nf_nodes = 1
  54
  55         # MACs used in packet headers.
  56         self.p1_dst_start_mac = u"52:54:00:00:00:01"
  57         self.p2_dst_start_mac = u"52:54:00:00:00:02"
  58
  59         # IPs used in packet headers.
  60         self.p1_src_start_ip = u"10.10.10.1"
  61         self.p1_src_end_ip = u"10.10.10.254"
  62         self.p1_dst_start_ip = u"20.20.20.1"
  63
  64         self.p2_src_start_ip = u"20.20.20.1"
  65         self.p2_src_end_ip = u"20.20.20.254"
  66         self.p2_dst_start_ip = u"10.10.10.1"
  67
  68     def define_packets(self):
  69         """Defines the packets to be sent from the traffic generator.
  70
  71         Packet definition: | ETH | IP |
  72
  73         :returns: Packets to be sent from the traffic generator.
  74         :rtype: tuple
  75         """
  76
  77         # Direction 0 --> 1
  78         base_pkt_a = (
  79             Ether(
  80                 dst=self.p1_dst_start_mac
  81             ) /
  82             IP(
  83                 src=self.p1_src_start_ip,
  84                 dst=self.p1_dst_start_ip,
  85                 proto=61
  86             )
  87         )
  88         # Direction 1 --> 0
  89         base_pkt_b = (
  90             Ether(
  91                 dst=self.p2_dst_start_mac
  92             ) /
  93             IP(
  94                 src=self.p2_src_start_ip,
  95                 dst=self.p2_dst_start_ip,
  96                 proto=61
  97             )
  98         )
  99
 100         # Direction 0 --> 1
 101         vm1 = STLScVmRaw(
 102             [
 103                 STLVmFlowVar(
 104                     name=u"mac_dst",
 105                     min_value=1,
 106                     max_value=self.nf_chains*self.nf_nodes,
 107                     size=1,
 108                     step=self.nf_nodes,
 109                     op=u"inc"
 110                 ),
 111                 STLVmWrFlowVar(
 112                     fv_name=u"mac_dst",
 113                     pkt_offset=4
 114                 ),
 115                 STLVmFlowVar(
 116                     name=u"src",
 117                     min_value=self.p1_src_start_ip,
 118                     max_value=self.p1_src_end_ip,
 119                     size=4, op=u"inc"
 120                 ),
 121                 STLVmWrFlowVar(
 122                     fv_name=u"src",
 123                     pkt_offset=u"IP.src"
 124                 ),
 125                 STLVmFixIpv4(
 126                     offset=u"IP"
 127                 )
 128             ]
 129         )
 130         # Direction 1 --> 0
 131         vm2 = STLScVmRaw(
 132             [
 133                 STLVmFlowVar(
 134                     name=u"mac_dst",
 135                     min_value=self.nf_nodes,
 136                     max_value=self.nf_chains*self.nf_nodes,
 137                     size=1,
 138                     step=self.nf_nodes,
 139                     op=u"inc"
 140                 ),
 141                 STLVmWrFlowVar(
 142                     fv_name=u"mac_dst",
 143                     pkt_offset=4
 144                 ),
 145                 STLVmFlowVar(
 146                     name=u"src",
 147                     min_value=self.p2_src_start_ip,
 148                     max_value=self.p2_src_end_ip,
 149                     size=4,
 150                     op=u"inc"
 151                 ),
 152                 STLVmWrFlowVar(
 153                     fv_name=u"src",
 154                     pkt_offset=u"IP.src"
 155                 ),
 156                 STLVmFixIpv4(
 157                     offset=u"IP"
 158                 )
 159             ]
 160         )
 161
 162         return base_pkt_a, base_pkt_b, vm1, vm2
 163
 164
 165 def register():
 166     """Register this traffic profile to T-rex.
 167
 168     Do not change this function.
 169
 170     :return: Traffic streams.
 171     :rtype: Object
 172     """
 173     return TrafficStreams()