GPL/traffic_profiles/trex/trex-astf-ethip4tcp-65536h-pps.py

   1 # Copyright (c) 2022 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 """Traffic profile for T-rex advanced stateful (astf) traffic generator.
  25
  26 Traffic profile:
  27  - Two streams sent in directions 0 --> 1 (client -> server, requests) and
  28    1 --> 0 (server -> client, responses) at the same time.
  29  - Packet: ETH / IP / TCP
  30  - Direction 0 --> 1:
  31    - Source IP address range:      192.168.0.0 - 192.168.255.255
  32    - Destination IP address range: 20.0.0.0 - 20.0.255.255
  33  - Direction 1 --> 0:
  34    - Source IP address range:      destination IP address from packet received
  35      on port 1
  36    - Destination IP address range: source IP address from packet received
  37      on port 1
  38
  39 This is a profile for PPS tests, it combines TCP connect and data transfer.
  40 No delays, server response waits for full request.
  41 """
  42
  43 from trex.astf.api import *
  44 from profile_trex_astf_base_class import TrafficProfileBaseClass
  45
  46
  47 class TrafficProfile(TrafficProfileBaseClass):
  48     """Traffic profile."""
  49
  50     def define_profile(self):
  51         """Define profile to be used by advanced stateful traffic generator.
  52
  53         This method MUST return:
  54
  55             return ip_gen, templates, None
  56
  57         :returns: IP generator and profile templates for ASTFProfile().
  58         :rtype: tuple
  59         """
  60         # IPs used in packet headers.
  61         p1_src_start_ip = u"192.168.0.0"
  62         p1_src_end_ip = u"192.168.255.255"
  63         p1_dst_start_ip = u"20.0.0.0"
  64         p1_dst_end_ip = u"20.0.255.255"
  65
  66         # Headers length, not sure why TRex needs 32B for segment header.
  67         real_headers_size = 70  # 18B L2 + 20B IPv4 + 32B TCP.
  68         trex_headers_size = real_headers_size - 12  # As if TCP header is 20B.
  69         trex_mss = self.framesize - trex_headers_size
  70         real_mss = trex_mss - 12  # TRex honors segment header+data limit.
  71         data_size = self.n_data_frames * real_mss
  72
  73         # client commands
  74         prog_c = ASTFProgram()
  75         prog_c.connect()
  76         prog_c.send(u"1" * data_size)
  77         prog_c.recv(data_size)
  78
  79         # server commands
  80         prog_s = ASTFProgram()
  81         prog_s.accept()
  82         prog_s.recv(data_size)
  83         prog_s.send(u"1" * data_size)
  84
  85         # ip generators
  86         ip_gen_c = ASTFIPGenDist(
  87             ip_range=[p1_src_start_ip, p1_src_end_ip],
  88             distribution=u"seq",
  89         )
  90         ip_gen_s = ASTFIPGenDist(
  91             ip_range=[p1_dst_start_ip, p1_dst_end_ip],
  92             distribution=u"seq",
  93         )
  94         ip_gen = ASTFIPGen(
  95             glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
  96             dist_client=ip_gen_c,
  97             dist_server=ip_gen_s,
  98         )
  99
 100         # server association
 101         s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
 102
 103         # template
 104         temp_c = ASTFTCPClientTemplate(
 105             program=prog_c,
 106             ip_gen=ip_gen,
 107             limit=4128768,  # TODO: set via input parameter
 108             port=8080,
 109         )
 110         temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
 111         template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
 112
 113         globinfo = ASTFGlobalInfo()
 114         # Ensure correct data frame size.
 115         globinfo.tcp.mss = trex_mss
 116         # Ensure the whole transaction is a single burst (per direction).
 117         globinfo.tcp.initwnd = self.n_data_frames
 118         # Ensure buffers are large enough so starting window works.
 119         globinfo.tcp.txbufsize = data_size
 120         globinfo.tcp.rxbufsize = data_size
 121         kwargs = dict(
 122             default_c_glob_info=globinfo,
 123             default_s_glob_info=globinfo,
 124         )
 125
 126         return ip_gen, template, kwargs
 127
 128
 129 def register():
 130     """Register this traffic profile to T-Rex.
 131
 132     Do not change this function.
 133
 134     :return: Traffic Profiles.
 135     :rtype: Object
 136     """
 137     return TrafficProfile()