1 # Copyright 2015-2017 Intel Corporation.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # ############################
16 # Traffic gen configuration
17 # ############################
19 # log file for all traffic generator related commands
20 LOG_FILE_TRAFFIC_GEN = 'traffic-gen.log'
22 # TRAFFIC dictionary defines traffic parameters used by all traffic generators.
23 # Detailed description of TRAFFIC dictionary items follows:
25 # 'traffic_type' - One of the supported traffic types.
26 # E.g. rfc2544_throughput, rfc2544_back2back
27 # or rfc2544_continuous
29 # Default value: "rfc2544_throughput".
30 # 'bidir' - Specifies if generated traffic will be full-duplex (True)
31 # or half-duplex (False)
33 # Supported values: "True", "False"
34 # Default value: "False".
35 # 'frame_rate' - Defines desired percentage of frame rate used during
36 # continuous stream tests.
39 # 'multistream' - Defines number of flows simulated by traffic generator.
40 # Value 0 disables multistream feature
42 # Supported values: 0-65536 for 'L4' stream type
43 # unlimited for 'L2' and 'L3' stream types
45 # 'stream_type' - Stream type is an extension of the "multistream" feature.
46 # If multistream is disabled, then stream type will be
47 # ignored. Stream type defines ISO OSI network layer used
48 # for simulation of multiple streams.
51 # "L2" - iteration of destination MAC address
52 # "L3" - iteration of destination IP address
53 # "L4" - iteration of destination port
54 # of selected transport protocol
55 # Default value: "L4".
56 # 'pre_installed_flows'
57 # - Pre-installed flows is an extension of the "multistream"
58 # feature. If enabled, it will implicitly insert a flow
59 # for each stream. If multistream is disabled, then
60 # pre-installed flows will be ignored.
61 # Note: It is supported only for p2p deployment scenario.
64 # "Yes" - flows will be inserted into OVS
65 # "No" - flows won't be inserted into OVS
66 # Default value: "No".
67 # 'flow_type' - Defines flows complexity.
70 # "port" - flow is defined by ingress ports
71 # "IP" - flow is defined by ingress ports
72 # and src and dst IP addresses
73 # Default value: "port"
74 # 'flow_control' - Controls flow control support by traffic generator.
76 # False - flow control is disabled
77 # True - flow control is enabled
78 # Default value: False
79 # Note: Currently it is supported by IxNet only
80 # 'learning_frames' - Controls learning frames support by traffic generator.
82 # False - learning freames are disabled
83 # True - learning freames are enabled
85 # Note: Currently it is supported by IxNet only
86 # 'l2' - A dictionary with l2 network layer details. Supported
88 # 'srcmac' - Specifies source MAC address filled by traffic generator.
89 # NOTE: It can be modified by vsperf in some scenarios.
91 # Default value: "00:00:00:00:00:00".
92 # 'dstmac' - Specifies destination MAC address filled by traffic generator.
93 # NOTE: It can be modified by vsperf in some scenarios.
95 # Default value: "00:00:00:00:00:00".
96 # 'framesize' - Specifies default frame size. This value should not be
97 # changed directly. It will be overridden during testcase
98 # execution by values specified by list TRAFFICGEN_PKT_SIZES.
101 # 'l3' - A dictionary with l3 network layer details. Supported
103 # 'enabled' - Specifies if l3 layer should be enabled or disabled.
105 # Default value: True
106 # NOTE: Supported only by IxNet trafficgen class
107 # 'srcip' - Specifies source MAC address filled by traffic generator.
108 # NOTE: It can be modified by vsperf in some scenarios.
110 # Default value: "1.1.1.1".
111 # 'dstip' - Specifies destination MAC address filled by traffic generator.
112 # NOTE: It can be modified by vsperf in some scenarios.
114 # Default value: "90.90.90.90".
115 # 'proto' - Specifies protocol type.
116 # Please check particular traffic generator implementation
117 # for supported protocol types.
119 # Default value: "udp".
120 # 'l4' - A dictionary with l4 network layer details. Supported
122 # 'enabled' - Specifies if l4 layer should be enabled or disabled.
124 # Default value: True
125 # NOTE: Supported only by IxNet trafficgen class
126 # 'srcport' - Specifies source port of selected transport protocol.
127 # NOTE: It can be modified by vsperf in some scenarios.
129 # Default value: 3000
130 # 'dstport' - Specifies destination port of selected transport protocol.
131 # NOTE: It can be modified by vsperf in some scenarios.
133 # Default value: 3001
134 # 'vlan' - A dictionary with vlan encapsulation details. Supported
136 # 'enabled' - Specifies if vlan encapsulation should be enabled or
139 # Default value: False
140 # 'id' - Specifies vlan id.
141 # Data type: int (NOTE: must fit to 12 bits)
143 # 'priority' - Specifies a vlan priority (PCP header field).
144 # Data type: int (NOTE: must fit to 3 bits)
146 # 'cfi' - Specifies if frames can or cannot be dropped during
147 # congestion (DEI header field).
148 # Data type: int (NOTE: must fit to 1 bit)
150 # 'capture' - A dictionary with traffic capture configuration.
151 # NOTE: It is supported only by T-Rex traffic generator.
152 # 'enabled' - Specifies if traffic should be captured
154 # Default value: False
155 # 'tx_ports' - A list of ports, where frames transmitted towards DUT will
156 # be captured. Ports have numbers 0 and 1. TX packet capture
157 # is disabled if list of ports is empty.
160 # 'rx_ports' - A list of ports, where frames received from DUT will
161 # be captured. Ports have numbers 0 and 1. RX packet capture
162 # is disabled if list of ports is empty.
165 # 'count' - A number of frames to be captured. The same count value
166 # is applied to both TX and RX captures.
169 # 'filter' - An expression used to filter TX and RX packets. It uses the same
170 # syntax as pcap library. See pcap-filter man page for additional
174 # 'scapy' - A dictionary with definition of a frame content for both traffic
175 # directions. The frame content is defined by a SCAPY notation.
176 # NOTE: It is supported only by the T-Rex traffic generator.
177 # Following keywords can be used to refer to the related parts of
178 # the TRAFFIC dictionary:
179 # Ether_src - refers to TRAFFIC['l2']['srcmac']
180 # Ether_dst - refers to TRAFFIC['l2']['dstmac']
181 # IP_proto - refers to TRAFFIC['l3']['proto']
182 # IP_PROTO - refers to upper case version of TRAFFIC['l3']['proto']
183 # IP_src - refers to TRAFFIC['l3']['srcip']
184 # IP_dst - refers to TRAFFIC['l3']['dstip']
185 # IP_PROTO_sport - refers to TRAFFIC['l4']['srcport']
186 # IP_PROTO_dport - refers to TRAFFIC['l4']['dstport']
187 # Dot1Q_prio - refers to TRAFFIC['vlan']['priority']
188 # Dot1Q_id - refers to TRAFFIC['vlan']['cfi']
189 # Dot1Q_vlan - refers to TRAFFIC['vlan']['id']
190 # '0' - A string with the frame definition for the 1st direction.
192 # Default value: 'Ether(src={Ether_src}, dst={Ether_dst})/'
193 # 'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
194 # 'IP(proto={IP_proto}, src={IP_src}, dst={IP_dst})/'
195 # '{IP_PROTO}(sport={IP_PROTO_sport}, dport={IP_PROTO_dport})'
196 # '1' - A string with the frame definition for the 2nd direction.
198 # Default value: 'Ether(src={Ether_dst}, dst={Ether_src})/'
199 # 'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
200 # 'IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/'
201 # '{IP_PROTO}(sport={IP_PROTO_dport}, dport={IP_PROTO_sport})',
203 'traffic_type' : 'rfc2544_throughput',
205 'bidir' : 'True', # will be passed as string in title format to tgen
207 'stream_type' : 'L4',
208 'pre_installed_flows' : 'No', # used by vswitch implementation
209 'flow_type' : 'port', # used by vswitch implementation
210 'flow_control' : False, # supported only by IxNet
211 'learning_frames' : True, # supported only by IxNet
214 'srcmac': '00:00:00:00:00:00',
215 'dstmac': '00:00:00:00:00:00',
221 'dstip': '90.90.90.90',
243 '0' : 'Ether(src={Ether_src}, dst={Ether_dst})/'
244 'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
245 'IP(proto={IP_proto}, src={IP_src}, dst={IP_dst})/'
246 '{IP_PROTO}(sport={IP_PROTO_sport}, dport={IP_PROTO_dport})',
247 '1' : 'Ether(src={Ether_dst}, dst={Ether_src})/'
248 'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
249 'IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/'
250 '{IP_PROTO}(sport={IP_PROTO_dport}, dport={IP_PROTO_sport})',
254 #path to traffic generators directory.
255 TRAFFICGEN_DIR = os.path.join(ROOT_DIR, 'tools/pkt_gen')
257 # traffic generator to use in tests
258 #TRAFFICGEN = 'TestCenter'
260 #TRAFFICGEN = 'IxNet'
263 #TRAFFICGEN = 'Moongen'
266 # List of packet sizes to send.
267 # Expand like this: (64, 128, 256, 512, 1024)
268 TRAFFICGEN_PKT_SIZES = (64,)
270 TRAFFICGEN_DURATION = 30
272 TRAFFICGEN_RFC2544_TESTS = 1
273 TRAFFICGEN_RFC2889_TRIALS = 1
274 TRAFFICGEN_LOSSRATE = 0.0
276 ##############################
277 # DUMMY Configuration -- BEGIN
279 # By default, dummy traffic generator asks for "measured" values.
280 # Following dictionary allows to preconfigure these values and
281 # to avoid user interaction. It can be useful for automated
283 # Example of values for continuous traffic type:
284 # TRAFFICGEN_DUMMY_RESULTS{'frames rx': 500000,
285 # 'frames tx': 500000,
291 # 'avg latency': 2.5,
294 TRAFFICGEN_DUMMY_RESULTS = {}
296 # DUMMY Configuration -- END
297 ############################
299 #############################
300 # IXIA Configuration -- BEGIN
302 # path to 'ixos' install path
303 TRAFFICGEN_IXIA_ROOT_DIR = '/opt/ixos'
305 # network address of IXIA chassis
306 TRAFFICGEN_IXIA_HOST = ''
308 TRAFFICGEN_IXIA_CARD = ''
310 TRAFFICGEN_IXIA_PORT1 = ''
312 TRAFFICGEN_IXIA_PORT2 = ''
314 TRAFFICGEN_IXNET_LIB_PATH = '/opt/ixnetwork/lib/IxTclNetwork'
316 # IxNetwork host IP address
317 TRAFFICGEN_IXNET_MACHINE = ''
318 TRAFFICGEN_IXNET_PORT = ''
319 TRAFFICGEN_IXNET_USER = ''
320 TRAFFICGEN_IXNET_CHASSIS = ''
322 # The result directory on $TRAFFICGEN_IXNET_MACHINE
323 TRAFFICGEN_IXNET_TESTER_RESULT_DIR = ''
325 # The result directory on DUT. This needs to map to the same directory
326 # as the previous one
327 TRAFFICGEN_IXNET_DUT_RESULT_DIR = ''
329 # directory with 3rd party scripts generated by IXIA tools
330 TRAFFICGEN_IXIA_3RD_PARTY = os.path.join(ROOT_DIR, '3rd_party/ixia')
332 # default TCL script, which will be used for IXNETWORK configuration
333 TRAFFICGEN_IXNET_TCL_SCRIPT = 'ixnetrfc2544.tcl'
335 # IXIA Configuration -- END
336 ###########################
339 ###########################################
340 # Spirent TestCenter Configuration -- BEGIN
342 # Path to Python 2 executable
343 TRAFFICGEN_STC_PYTHON2_PATH = "/bin/python2.7"
345 # Path to the location of the TestCenter files
346 TRAFFICGEN_STC_TESTCENTER_PATH = os.path.join(ROOT_DIR, 'tools/pkt_gen/testcenter')
348 # Name of the TestCenter RFC2544 Tput helper python script
349 TRAFFICGEN_STC_RFC2544_TPUT_TEST_FILE_NAME = "testcenter-rfc2544-throughput.py"
351 # Name of the Testcenter RFC2899 Tput Helper Python Scripts
352 TRAFFICGEN_STC_RFC2889_TEST_FILE_NAME = "testcenter-rfc2889-rest.py"
354 # 2889 Port Locations
355 TRAFFICGEN_STC_RFC2889_LOCATION = ""
357 # The address of the Spirent Lab Server to use
358 TRAFFICGEN_STC_LAB_SERVER_ADDR = ""
360 # The address of the Spirent License Server in your environment
361 TRAFFICGEN_STC_LICENSE_SERVER_ADDR = ""
363 # The address of the TestCenter chassis that holds the east port
364 TRAFFICGEN_STC_EAST_CHASSIS_ADDR = ""
366 # The slot number of the card that holds the east port
367 TRAFFICGEN_STC_EAST_SLOT_NUM = ""
369 # The port number on the card that holds the east port
370 TRAFFICGEN_STC_EAST_PORT_NUM = ""
372 # The address of the TestCenter chassis that holds the west port
373 TRAFFICGEN_STC_WEST_CHASSIS_ADDR = ""
375 # The slot number of the card that holds the west port
376 TRAFFICGEN_STC_WEST_SLOT_NUM = ""
378 # The port number on the card that holds the west port
379 TRAFFICGEN_STC_WEST_PORT_NUM = ""
381 # The friendly name to identify the Spirent Lab Server test session
382 TRAFFICGEN_STC_TEST_SESSION_NAME = "RFC2544 Tput"
383 # The directory to copy results to
385 TRAFFICGEN_STC_RESULTS_DIR = os.path.join(ROOT_DIR, "Results")
386 # The prefix for the CSV results file
388 TRAFFICGEN_STC_CSV_RESULTS_FILE_PREFIX = "RFC2544_tput"
389 # The number of trials to execute during the test
391 TRAFFICGEN_STC_NUMBER_OF_TRIALS = "1"
393 # The duration of each trial executed during the test, in seconds
394 TRAFFICGEN_STC_TRIAL_DURATION_SEC = "60"
396 # The traffic pattern between endpoints, BACKBONE, MESH or PAIR
397 TRAFFICGEN_STC_TRAFFIC_PATTERN = "PAIR"
399 # The search mode used to find the throughput rate, COMBO, STEP or BINARY
400 TRAFFICGEN_STC_SEARCH_MODE = "BINARY"
402 # The learning mode used during the test, AUTO, L2_LEARNING, L3_LERNING, or NONE
403 TRAFFICGEN_STC_LEARNING_MODE = "AUTO"
405 # The minimum percent line rate that will be used during the test
406 TRAFFICGEN_STC_RATE_LOWER_LIMIT_PCT = "1.0"
408 # The maximum percent line rate that will be used during the test
409 TRAFFICGEN_STC_RATE_UPPER_LIMIT_PCT = "99.0"
411 # If SearchMode is BINARY, the percent line rate that will be used at the start of the test
412 TRAFFICGEN_STC_RATE_INITIAL_PCT = "99.0"
414 # When SearchMode is STEP, the percent increase in load per step
415 TRAFFICGEN_STC_RATE_STEP_PCT = "10.0"
417 # The minimum percentage of load adjustment between iterations
418 TRAFFICGEN_STC_RESOLUTION_PCT = "1.0"
420 # The frame size, in bytes
421 TRAFFICGEN_STC_FRAME_SIZE = "256"
423 # The maximum acceptable frame loss percent in any iteration
424 TRAFFICGEN_STC_ACCEPTABLE_FRAME_LOSS_PCT = "0.0"
426 # The address to assign to the first emulated device interface on the first east port
427 TRAFFICGEN_STC_EAST_INTF_ADDR = ""
429 # The gateway address to assign to the first emulated device interface on the first east port
430 TRAFFICGEN_STC_EAST_INTF_GATEWAY_ADDR = ""
432 # The address to assign to the first emulated device interface on the first west port
433 TRAFFICGEN_STC_WEST_INTF_ADDR = ""
435 # The gateway address to assign to the first emulated device interface on the first west port
436 TRAFFICGEN_STC_WEST_INTF_GATEWAY_ADDR = ""
438 # Print additional information to the terminal during the test
439 TRAFFICGEN_STC_VERBOSE = "True"
441 # Spirent TestCenter Configuration -- END
442 #########################################
444 #############################
445 # Xena Configuration -- BEGIN
447 # Xena traffic generator connection info
448 TRAFFICGEN_XENA_IP = ''
449 TRAFFICGEN_XENA_PORT1 = ''
450 TRAFFICGEN_XENA_PORT2 = ''
451 TRAFFICGEN_XENA_USER = ''
452 TRAFFICGEN_XENA_PASSWORD = ''
453 TRAFFICGEN_XENA_MODULE1 = ''
454 TRAFFICGEN_XENA_MODULE2 = ''
457 TRAFFICGEN_XENA_PORT0_IP = '192.168.199.10'
458 TRAFFICGEN_XENA_PORT0_CIDR = 24
459 TRAFFICGEN_XENA_PORT0_GATEWAY = '192.168.199.1'
460 TRAFFICGEN_XENA_PORT1_IP = '192.168.199.11'
461 TRAFFICGEN_XENA_PORT1_CIDR = 24
462 TRAFFICGEN_XENA_PORT1_GATEWAY = '192.168.199.1'
464 # Xena RFC 2544 options
465 # Please reference xena documentation before making changes to these settings
466 TRAFFICGEN_XENA_2544_TPUT_INIT_VALUE = '10.0'
467 TRAFFICGEN_XENA_2544_TPUT_MIN_VALUE = '0.1'
468 TRAFFICGEN_XENA_2544_TPUT_MAX_VALUE = '100.0'
469 TRAFFICGEN_XENA_2544_TPUT_VALUE_RESOLUTION = '0.5'
470 TRAFFICGEN_XENA_2544_TPUT_USEPASS_THRESHHOLD = 'false'
471 TRAFFICGEN_XENA_2544_TPUT_PASS_THRESHHOLD = '0.0'
473 # Xena RFC 2544 final verification options
474 TRAFFICGEN_XENA_RFC2544_VERIFY = False
475 TRAFFICGEN_XENA_RFC2544_VERIFY_DURATION = 120 # in seconds
476 # Number of verify attempts before giving up...
477 TRAFFICGEN_XENA_RFC2544_MAXIMUM_VERIFY_ATTEMPTS = 10
478 # Logic for restarting binary search, see documentation for details
479 TRAFFICGEN_XENA_RFC2544_BINARY_RESTART_SMART_SEARCH = True
481 # Xena Continuous traffic options
482 # Please reference xena documentation before making changes to these settings
483 TRAFFICGEN_XENA_CONT_PORT_LEARNING_ENABLED = True
484 TRAFFICGEN_XENA_CONT_PORT_LEARNING_DURATION = 3
486 # Xena Configuration -- END
487 ###########################
489 ###################################################
490 # MoonGen Configuration and Connection Info-- BEGIN
492 # Ex: TRAFFICGEN_MOONGEN_HOST_IP_ADDR = "192.10.1.1"
493 TRAFFICGEN_MOONGEN_HOST_IP_ADDR = ''
494 TRAFFICGEN_MOONGEN_USER = ''
495 TRAFFICGEN_MOONGEN_BASE_DIR = ''
496 TRAFFICGEN_MOONGEN_PORTS = ''
497 # Ex. 10 Gbps: TRAFFICGEN_MOONGEN_LINE_SPEED_GBPS = '10'
498 # Today only 10 Gbps is supported
499 TRAFFICGEN_MOONGEN_LINE_SPEED_GBPS = ''
501 # MoonGen Configuration and Connection Info-- END
502 #################################################
504 ################################################
505 # Trex Configuration and Connection Info-- BEGIN
507 # Example: TRAFFICGEN_TREX_HOST_IP_ADDR = "192.10.1.1"
508 # Example: TRAFFICGEN_TREX_USER = 'root'
509 # Example: TRAFFICGEN_TREX_BASE_DIR = '/traffic_gen/trex/'
510 # Example: TRAFFICGEN_TREX_PORT1 = '00:00:00:00:00:00'
511 TRAFFICGEN_TREX_HOST_IP_ADDR = ''
512 TRAFFICGEN_TREX_USER = ''
513 TRAFFICGEN_TREX_BASE_DIR = ''
514 TRAFFICGEN_TREX_PORT1 = ''
515 TRAFFICGEN_TREX_PORT2 = ''
516 # RFC2544 Throughput execution will end after threshold below is reached.
517 # It defines maximal difference between frame rate of successful (i.e. defined
518 # frameloss reached) and unsuccessful (i.e. frameloss exceeded) iterations.
519 TRAFFICGEN_TREX_RFC2544_TPUT_THRESHOLD = 0.05
520 # Latency statistics are collected by separate stream created for each interface.
521 # Parameter below defines frequency of packets used for latency measurement in PPS.
522 # Value 0 will disable latency specific streams.
523 TRAFFICGEN_TREX_LATENCY_PPS = 1000
524 # Enablement of learning packets before sending test traffic
525 TRAFFICGEN_TREX_LEARNING_MODE = True
526 TRAFFICGEN_TREX_LEARNING_DURATION = 5
527 # FOR SR-IOV or multistream layer 2 tests to work with T-Rex enable Promiscuous mode
528 TRAFFICGEN_TREX_PROMISCUOUS = False
529 # Enable below options to force T-rex api to attempt to use speed specified on server
530 # side when pushing traffic. For 40G use 40000. For 25G use 25000.
531 TRAFFICGEN_TREX_FORCE_PORT_SPEED = False
532 TRAFFICGEN_TREX_PORT_SPEED = 10000 # 10G
534 PATHS['trafficgen'] = {
538 'path': os.path.join(ROOT_DIR, 'src/trex/trex/scripts/automation/trex_control_plane/stl')
542 # TRex validation option for RFC2544
543 TRAFFICGEN_TREX_VERIFICATION_MODE = False
544 TRAFFICGEN_TREX_VERIFICATION_DURATION = 60
545 TRAFFICGEN_TREX_MAXIMUM_VERIFICATION_TRIALS = 10
546 # TREX Configuration and Connection Info-- END
547 ##############################################