GPL/traffic_profiles/trex/trex-astf-ethip4udp-4096h.py

   1 # Copyright (c) 2020 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Traffic profile for T-rex advanced stateful (astf) traffic generator.
  15
  16 Traffic profile:
  17  - Two streams sent in directions 0 --> 1 (client -> server, requests) and
  18    1 --> 0 (server -> client, responses) at the same time.
  19  - Packet: ETH / IP / UDP
  20  - Direction 0 --> 1:
  21    - Source IP address range:      192.168.0.0 - 192.168.15.255
  22    - Destination IP address range: 20.0.0.0 - 20.0.15.255
  23  - Direction 1 --> 0:
  24    - Source IP address range:      destination IP address from packet received
  25      on port 1
  26    - Destination IP address range: source IP address from packet received
  27      on port 1
  28 """
  29
  30 from trex.astf.api import *
  31
  32 from profile_trex_astf_base_class import TrafficProfileBaseClass
  33
  34
  35 class TrafficProfile(TrafficProfileBaseClass):
  36     """Traffic profile."""
  37
  38     def __init__(self):
  39         """Initialization and setting of profile parameters."""
  40
  41         super(TrafficProfileBaseClass, self).__init__()
  42
  43         # IPs used in packet headers.
  44         self.p1_src_start_ip = u"192.168.0.0"
  45         self.p1_src_end_ip = u"192.168.15.255"
  46         self.p1_dst_start_ip = u"20.0.0.0"
  47         self.p1_dst_end_ip = u"20.0.15.255"
  48
  49         # UDP messages
  50         self.udp_req = u"GET"
  51         self.udp_res = u"ACK"
  52
  53         # Headers length
  54         self.headers_size = 42  # 14B l2 + 20B ipv4 + 8B udp
  55
  56         # Required UDP keepalive value for T-Rex
  57         self.udp_keepalive = 2000  # 2s (2,000 msec)
  58
  59     def define_profile(self):
  60         """Define profile to be used by advanced stateful traffic generator.
  61
  62         This method MUST return:
  63             return ip_gen, templates, None
  64
  65         :returns: IP generator and profile templates ASTFProfile().
  66         :rtype: tuple
  67         """
  68         self.udp_req += self._gen_padding(self.headers_size + len(self.udp_req))
  69         self.udp_res += self._gen_padding(self.headers_size + len(self.udp_res))
  70
  71         # client commands
  72         prog_c = ASTFProgram(stream=False)
  73         # set the keepalive timer for UDP flows to not close udp session
  74         # immediately after packet exchange
  75         prog_c.set_keepalive_msg(self.udp_keepalive)
  76         # send REQ message
  77         prog_c.send_msg(self.udp_req)
  78         # receive RES message
  79         prog_c.recv_msg(1)
  80
  81         prog_c.delay(self.udp_keepalive * 1000)  # delay is defined in usec
  82
  83         # server commands
  84         prog_s = ASTFProgram(stream=False)
  85         # set the keepalive timer for UDP flows to not close udp session
  86         # immediately after packet exchange
  87         prog_c.set_keepalive_msg(self.udp_keepalive)
  88         # receive REQ message
  89         prog_s.recv_msg(1)
  90         # send RES message
  91         prog_s.send_msg(self.udp_res)
  92
  93         prog_s.delay(self.udp_keepalive * 1000)  # delay is defined in usec
  94
  95         # ip generators
  96         ip_gen_c = ASTFIPGenDist(
  97             ip_range=[self.p1_src_start_ip, self.p1_src_end_ip],
  98             distribution=u"seq"
  99         )
 100         ip_gen_s = ASTFIPGenDist(
 101             ip_range=[self.p1_dst_start_ip, self.p1_dst_end_ip],
 102             distribution=u"seq"
 103         )
 104         ip_gen = ASTFIPGen(
 105             glob=ASTFIPGenGlobal(ip_offset=u"0.0.0.1"),
 106             dist_client=ip_gen_c,
 107             dist_server=ip_gen_s
 108         )
 109
 110         # server association
 111         s_assoc = ASTFAssociation(rules=ASTFAssociationRule(port=8080))
 112
 113         # template
 114         temp_c = ASTFTCPClientTemplate(
 115             program=prog_c,
 116             ip_gen=ip_gen,
 117             limit=258048,  # TODO: set via input parameter ?
 118             port=8080
 119         )
 120         temp_s = ASTFTCPServerTemplate(program=prog_s, assoc=s_assoc)
 121         template = ASTFTemplate(client_template=temp_c, server_template=temp_s)
 122
 123         return ip_gen, template, None
 124
 125
 126 def register():
 127     """Register this traffic profile to T-Rex.
 128
 129     Do not change this function.
 130
 131     :return: Traffic Profiles.
 132     :rtype: Object
 133     """
 134     return TrafficProfile()