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