GPL/traffic_profiles/trex/trex-stl-2n-ethip4-macsrc500kdst500k.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    - Source MAC address range:      ca:fe:00:00:00:00 - ca:fe:00:07:a1:1f
  31    - Destination MAC address range: fa:ce:00:00:00:00 - fa:ce:00:07:a1:1f
  32    - Source IP address range:       10.0.0.0 - 10.7.161.31
  33    - Destination IP address range:  20.0.0.0 - 20.7.161.31
  34  - Direction 1 --> 0:
  35    - Source MAC address range:      fa:ce:00:00:00:00 - fa:ce:00:07:a1:1f
  36    - Destination MAC address range: ca:fe:00:00:00:00 - ca:fe:00:07:a1:1f
  37    - Source IP address range:       20.0.0.0 - 20.7.161.31
  38    - Destination IP address range:  10.0.0.0 - 10.7.161.31
  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         self.clients = 500000
  54
  55         # MACs used in packet headers.
  56         self.p1_src_start_mac = u"ca:fe:00:00:00:00" # mask: 00:00:FF:FF:FF:FF
  57         self.p1_dst_start_mac = u"fa:ce:00:00:00:00" # mask: 00:00:FF:FF:FF:FF
  58
  59         self.p2_src_start_mac = u"fa:ce:00:00:00:00" # mask: 00:00:FF:FF:FF:FF
  60         self.p2_dst_start_mac = u"ca:fe:00:00:00:00" # mask: 00:00:FF:FF:FF:FF
  61
  62         # IPs used in packet headers.
  63         self.p1_src_start_ip = u"10.0.0.0"
  64         self.p1_src_end_ip = u"10.7.161.31"
  65
  66         self.p1_dst_start_ip = u"20.0.0.0"
  67         self.p1_dst_end_ip = u"20.7.161.31"
  68
  69         self.p2_src_start_ip = u"20.0.0.0"
  70         self.p2_src_end_ip = u"20.7.161.31"
  71
  72         self.p2_dst_start_ip = u"10.0.0.0"
  73         self.p2_dst_end_ip = u"10.7.161.31"
  74
  75     def define_packets(self):
  76         """Defines the packets to be sent from the traffic generator.
  77
  78         Packet definition: | ETH | IP |
  79
  80         :returns: Packets to be sent from the traffic generator.
  81         :rtype: tuple
  82         """
  83
  84         # Direction 0 --> 1
  85         base_pkt_a = (
  86             Ether(
  87                 src=self.p1_src_start_mac,
  88                 dst=self.p1_dst_start_mac
  89             ) /
  90             IP(
  91                 src=self.p1_src_start_ip,
  92                 dst=self.p1_dst_start_ip,
  93                 proto=61
  94             )
  95         )
  96         # Direction 1 --> 0
  97         base_pkt_b = (
  98             Ether(
  99                 src=self.p2_src_start_mac,
 100                 dst=self.p2_dst_start_mac
 101             ) /
 102             IP(
 103                 src=self.p2_src_start_ip,
 104                 dst=self.p2_dst_start_ip,
 105                 proto=61
 106             )
 107         )
 108
 109         # Direction 0 --> 1
 110         vm1 = STLScVmRaw(
 111             [
 112                 STLVmFlowVar(
 113                     name=u"mac_src",
 114                     min_value=0,
 115                     max_value=self.clients-1,
 116                     size=4,
 117                     op=u"inc"
 118                 ),
 119                 STLVmFlowVar(
 120                     name=u"mac_dst",
 121                     min_value=0,
 122                     max_value=self.clients-1,
 123                     size=4,
 124                     op=u"inc"
 125                 ),
 126                 STLVmWrFlowVar(
 127                     fv_name=u"mac_src",
 128                     pkt_offset= 8
 129                 ),
 130                 STLVmWrFlowVar(
 131                     fv_name=u"mac_dst",
 132                     pkt_offset= 2
 133                 ),
 134                 STLVmFlowVar(
 135                     name=u"ip_src",
 136                     min_value=self.p1_src_start_ip,
 137                     max_value=self.p1_src_end_ip,
 138                     size=4,
 139                     op=u"inc"
 140                 ),
 141                 STLVmWrFlowVar(
 142                     fv_name=u"ip_src",
 143                     pkt_offset=u"IP.src"
 144                 ),
 145                 STLVmFlowVar(
 146                     name=u"ip_dst",
 147                     min_value=self.p1_dst_start_ip,
 148                     max_value=self.p1_dst_end_ip,
 149                     size=4,
 150                     op=u"inc"
 151                 ),
 152                 STLVmWrFlowVar(
 153                       fv_name=u"ip_dst",
 154                       pkt_offset=u"IP.dst"
 155                 ),
 156                 STLVmFixIpv4(
 157                       offset=u"IP"
 158                 )
 159             ]
 160         )
 161         # Direction 1 --> 0
 162         vm2 = STLScVmRaw(
 163             [
 164                 STLVmFlowVar(
 165                     name=u"mac_src",
 166                     min_value=0,
 167                     max_value=self.clients-1,
 168                     size=4,
 169                     op=u"inc"
 170                 ),
 171                 STLVmFlowVar(
 172                     name=u"mac_dst",
 173                     min_value=0,
 174                     max_value=self.clients-1,
 175                     size=4,
 176                     op=u"inc"
 177                 ),
 178                 STLVmWrFlowVar(
 179                     fv_name=u"mac_src",
 180                     pkt_offset= 8
 181                 ),
 182                 STLVmWrFlowVar(
 183                     fv_name=u"mac_dst",
 184                     pkt_offset= 2
 185                 ),
 186                 STLVmFlowVar(
 187                     name=u"ip_src",
 188                     min_value=self.p2_src_start_ip,
 189                     max_value=self.p2_src_end_ip,
 190                     size=4,
 191                     op=u"inc"
 192                 ),
 193                 STLVmWrFlowVar(
 194                     fv_name=u"ip_src",
 195                     pkt_offset=u"IP.src"
 196                 ),
 197                 STLVmFlowVar(
 198                     name=u"ip_dst",
 199                     min_value=self.p2_dst_start_ip,
 200                     max_value=self.p2_dst_end_ip,
 201                     size=4,
 202                     op=u"inc"
 203                 ),
 204                 STLVmWrFlowVar(
 205                     fv_name=u"ip_dst",
 206                     pkt_offset=u"IP.dst"
 207                 ),
 208                 STLVmFixIpv4(
 209                     offset=u"IP"
 210                 )
 211             ]
 212         )
 213
 214         return base_pkt_a, base_pkt_b, vm1, vm2
 215
 216
 217 def register():
 218     """Register this traffic profile to T-rex.
 219
 220     Do not change this function.
 221
 222     :return: Traffic streams.
 223     :rtype: Object
 224     """
 225     return TrafficStreams()