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 # rfc2544_continuous or burst
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 # 'burst_size' - Defines a number of frames in the single burst, which is sent
40 # by burst traffic type. Burst size is applied for each direction,
41 # i.e. the total number of tx frames will be 2*burst_size in case of
42 # bidirectional traffic.
45 # 'multistream' - Defines number of flows simulated by traffic generator.
46 # Value 0 disables multistream feature
48 # Supported values: 0-65536 for 'L4' stream type
49 # unlimited for 'L2' and 'L3' stream types
51 # 'stream_type' - Stream type is an extension of the "multistream" feature.
52 # If multistream is disabled, then stream type will be
53 # ignored. Stream type defines ISO OSI network layer used
54 # for simulation of multiple streams.
57 # "L2" - iteration of destination MAC address
58 # "L3" - iteration of destination IP address
59 # "L4" - iteration of destination port
60 # of selected transport protocol
61 # Default value: "L4".
62 # 'pre_installed_flows'
63 # - Pre-installed flows is an extension of the "multistream"
64 # feature. If enabled, it will implicitly insert a flow
65 # for each stream. If multistream is disabled, then
66 # pre-installed flows will be ignored.
67 # Note: It is supported only for p2p deployment scenario.
70 # "Yes" - flows will be inserted into OVS
71 # "No" - flows won't be inserted into OVS
72 # Default value: "No".
73 # 'flow_type' - Defines flows complexity.
76 # "port" - flow is defined by ingress ports
77 # "IP" - flow is defined by ingress ports
78 # and src and dst IP addresses
79 # Default value: "port"
80 # 'flow_control' - Controls flow control support by traffic generator.
82 # False - flow control is disabled
83 # True - flow control is enabled
84 # Default value: False
85 # Note: Currently it is supported by IxNet only
86 # 'learning_frames' - Controls learning frames support by traffic generator.
88 # False - learning freames are disabled
89 # True - learning freames are enabled
91 # Note: Currently it is supported by IxNet only
92 # 'l2' - A dictionary with l2 network layer details. Supported
94 # 'srcmac' - Specifies source MAC address filled by traffic generator.
95 # NOTE: It can be modified by vsperf in some scenarios.
97 # Default value: "00:00:00:00:00:00".
98 # 'dstmac' - Specifies destination MAC address filled by traffic generator.
99 # NOTE: It can be modified by vsperf in some scenarios.
101 # Default value: "00:00:00:00:00:00".
102 # 'framesize' - Specifies default frame size. This value should not be
103 # changed directly. It will be overridden during testcase
104 # execution by values specified by list TRAFFICGEN_PKT_SIZES.
107 # 'l3' - A dictionary with l3 network layer details. Supported
109 # 'enabled' - Specifies if l3 layer should be enabled or disabled.
111 # Default value: True
112 # NOTE: Supported only by IxNet trafficgen class
113 # 'srcip' - Specifies source MAC address filled by traffic generator.
114 # NOTE: It can be modified by vsperf in some scenarios.
116 # Default value: "1.1.1.1".
117 # 'dstip' - Specifies destination MAC address filled by traffic generator.
118 # NOTE: It can be modified by vsperf in some scenarios.
120 # Default value: "90.90.90.90".
121 # 'proto' - Specifies protocol type.
122 # Please check particular traffic generator implementation
123 # for supported protocol types.
125 # Default value: "udp".
126 # 'l4' - A dictionary with l4 network layer details. Supported
128 # 'enabled' - Specifies if l4 layer should be enabled or disabled.
130 # Default value: True
131 # NOTE: Supported only by IxNet trafficgen class
132 # 'srcport' - Specifies source port of selected transport protocol.
133 # NOTE: It can be modified by vsperf in some scenarios.
135 # Default value: 3000
136 # 'dstport' - Specifies destination port of selected transport protocol.
137 # NOTE: It can be modified by vsperf in some scenarios.
139 # Default value: 3001
140 # 'vlan' - A dictionary with vlan encapsulation details. Supported
142 # 'enabled' - Specifies if vlan encapsulation should be enabled or
145 # Default value: False
146 # 'id' - Specifies vlan id.
147 # Data type: int (NOTE: must fit to 12 bits)
149 # 'priority' - Specifies a vlan priority (PCP header field).
150 # Data type: int (NOTE: must fit to 3 bits)
152 # 'cfi' - Specifies if frames can or cannot be dropped during
153 # congestion (DEI header field).
154 # Data type: int (NOTE: must fit to 1 bit)
156 # 'capture' - A dictionary with traffic capture configuration.
157 # NOTE: It is supported only by T-Rex traffic generator.
158 # 'enabled' - Specifies if traffic should be captured
160 # Default value: False
161 # 'tx_ports' - A list of ports, where frames transmitted towards DUT will
162 # be captured. Ports have numbers 0 and 1. TX packet capture
163 # is disabled if list of ports is empty.
166 # 'rx_ports' - A list of ports, where frames received from DUT will
167 # be captured. Ports have numbers 0 and 1. RX packet capture
168 # is disabled if list of ports is empty.
171 # 'count' - A number of frames to be captured. The same count value
172 # is applied to both TX and RX captures.
175 # 'filter' - An expression used to filter TX and RX packets. It uses the same
176 # syntax as pcap library. See pcap-filter man page for additional
180 # 'scapy' - A dictionary with definition of a frame content for both traffic
181 # directions. The frame content is defined by a SCAPY notation.
182 # NOTE: It is supported only by the T-Rex traffic generator.
183 # Following keywords can be used to refer to the related parts of
184 # the TRAFFIC dictionary:
185 # Ether_src - refers to TRAFFIC['l2']['srcmac']
186 # Ether_dst - refers to TRAFFIC['l2']['dstmac']
187 # IP_proto - refers to TRAFFIC['l3']['proto']
188 # IP_PROTO - refers to upper case version of TRAFFIC['l3']['proto']
189 # IP_src - refers to TRAFFIC['l3']['srcip']
190 # IP_dst - refers to TRAFFIC['l3']['dstip']
191 # IP_PROTO_sport - refers to TRAFFIC['l4']['srcport']
192 # IP_PROTO_dport - refers to TRAFFIC['l4']['dstport']
193 # Dot1Q_prio - refers to TRAFFIC['vlan']['priority']
194 # Dot1Q_id - refers to TRAFFIC['vlan']['cfi']
195 # Dot1Q_vlan - refers to TRAFFIC['vlan']['id']
196 # '0' - A string with the frame definition for the 1st direction.
198 # Default value: 'Ether(src={Ether_src}, dst={Ether_dst})/'
199 # 'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
200 # 'IP(proto={IP_proto}, src={IP_src}, dst={IP_dst})/'
201 # '{IP_PROTO}(sport={IP_PROTO_sport}, dport={IP_PROTO_dport})'
202 # '1' - A string with the frame definition for the 2nd direction.
204 # Default value: 'Ether(src={Ether_dst}, dst={Ether_src})/'
205 # 'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
206 # 'IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/'
207 # '{IP_PROTO}(sport={IP_PROTO_dport}, dport={IP_PROTO_sport})',
209 'traffic_type' : 'rfc2544_throughput',
212 'bidir' : 'True', # will be passed as string in title format to tgen
214 'stream_type' : 'L4',
215 'pre_installed_flows' : 'No', # used by vswitch implementation
216 'flow_type' : 'port', # used by vswitch implementation
217 'flow_control' : False, # supported only by IxNet
218 'learning_frames' : True, # supported only by IxNet
221 'srcmac': '00:00:00:00:00:00',
222 'dstmac': '00:00:00:00:00:00',
228 'dstip': '90.90.90.90',
250 '0' : 'Ether(src={Ether_src}, dst={Ether_dst})/'
251 'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
252 'IP(proto={IP_proto}, src={IP_src}, dst={IP_dst})/'
253 '{IP_PROTO}(sport={IP_PROTO_sport}, dport={IP_PROTO_dport})',
254 '1' : 'Ether(src={Ether_dst}, dst={Ether_src})/'
255 'Dot1Q(prio={Dot1Q_prio}, id={Dot1Q_id}, vlan={Dot1Q_vlan})/'
256 'IP(proto={IP_proto}, src={IP_dst}, dst={IP_src})/'
257 '{IP_PROTO}(sport={IP_PROTO_dport}, dport={IP_PROTO_sport})',
261 #path to traffic generators directory.
262 TRAFFICGEN_DIR = os.path.join(ROOT_DIR, 'tools/pkt_gen')
264 # traffic generator to use in tests
265 #TRAFFICGEN = 'TestCenter'
267 #TRAFFICGEN = 'IxNet'
270 #TRAFFICGEN = 'Moongen'
273 # List of packet sizes to send.
274 # Expand like this: (64, 128, 256, 512, 1024)
275 TRAFFICGEN_PKT_SIZES = (64,)
277 TRAFFICGEN_DURATION = 30
279 TRAFFICGEN_RFC2544_TESTS = 1
280 TRAFFICGEN_RFC2889_TRIALS = 1
281 TRAFFICGEN_LOSSRATE = 0.0
283 ##############################
284 # DUMMY Configuration -- BEGIN
286 # By default, dummy traffic generator asks for "measured" values.
287 # Following dictionary allows to preconfigure these values and
288 # to avoid user interaction. It can be useful for automated
290 # Example of values for continuous traffic type:
291 # TRAFFICGEN_DUMMY_RESULTS{'frames rx': 500000,
292 # 'frames tx': 500000,
298 # 'avg latency': 2.5,
301 TRAFFICGEN_DUMMY_RESULTS = {}
303 # DUMMY Configuration -- END
304 ############################
306 #############################
307 # IXIA Configuration -- BEGIN
309 # path to 'ixos' install path
310 TRAFFICGEN_IXIA_ROOT_DIR = '/opt/ixos'
312 # network address of IXIA chassis
313 TRAFFICGEN_IXIA_HOST = ''
315 TRAFFICGEN_IXIA_CARD = ''
317 TRAFFICGEN_IXIA_PORT1 = ''
319 TRAFFICGEN_IXIA_PORT2 = ''
321 TRAFFICGEN_IXNET_LIB_PATH = '/opt/ixnetwork/lib/IxTclNetwork'
323 # IxNetwork host IP address
324 TRAFFICGEN_IXNET_MACHINE = ''
325 TRAFFICGEN_IXNET_PORT = ''
326 TRAFFICGEN_IXNET_USER = ''
327 TRAFFICGEN_IXNET_CHASSIS = ''
329 # The result directory on $TRAFFICGEN_IXNET_MACHINE
330 TRAFFICGEN_IXNET_TESTER_RESULT_DIR = ''
332 # The result directory on DUT. This needs to map to the same directory
333 # as the previous one
334 TRAFFICGEN_IXNET_DUT_RESULT_DIR = ''
336 # directory with 3rd party scripts generated by IXIA tools
337 TRAFFICGEN_IXIA_3RD_PARTY = os.path.join(ROOT_DIR, '3rd_party/ixia')
339 # default TCL script, which will be used for IXNETWORK configuration
340 TRAFFICGEN_IXNET_TCL_SCRIPT = 'ixnetrfc2544.tcl'
342 # IXIA Configuration -- END
343 ###########################
346 ###########################################
347 # Spirent TestCenter Configuration -- BEGIN
349 # Path to Python 2 executable
350 TRAFFICGEN_STC_PYTHON2_PATH = "/bin/python2.7"
352 # Path to the location of the TestCenter files
353 TRAFFICGEN_STC_TESTCENTER_PATH = os.path.join(ROOT_DIR, 'tools/pkt_gen/testcenter')
355 # Name of the TestCenter RFC2544 Tput helper python script
356 TRAFFICGEN_STC_RFC2544_TPUT_TEST_FILE_NAME = "testcenter-rfc2544-throughput.py"
358 # Name of the Testcenter RFC2899 Tput Helper Python Scripts
359 TRAFFICGEN_STC_RFC2889_TEST_FILE_NAME = "testcenter-rfc2889-rest.py"
361 # 2889 Port Locations
362 TRAFFICGEN_STC_RFC2889_LOCATION = ""
364 # The address of the Spirent Lab Server to use
365 TRAFFICGEN_STC_LAB_SERVER_ADDR = ""
367 # The address of the Spirent License Server in your environment
368 TRAFFICGEN_STC_LICENSE_SERVER_ADDR = ""
370 # The address of the TestCenter chassis that holds the east port
371 TRAFFICGEN_STC_EAST_CHASSIS_ADDR = ""
373 # The slot number of the card that holds the east port
374 TRAFFICGEN_STC_EAST_SLOT_NUM = ""
376 # The port number on the card that holds the east port
377 TRAFFICGEN_STC_EAST_PORT_NUM = ""
379 # The address of the TestCenter chassis that holds the west port
380 TRAFFICGEN_STC_WEST_CHASSIS_ADDR = ""
382 # The slot number of the card that holds the west port
383 TRAFFICGEN_STC_WEST_SLOT_NUM = ""
385 # The port number on the card that holds the west port
386 TRAFFICGEN_STC_WEST_PORT_NUM = ""
388 # The friendly name to identify the Spirent Lab Server test session
389 TRAFFICGEN_STC_TEST_SESSION_NAME = "RFC2544 Tput"
390 # The directory to copy results to
392 TRAFFICGEN_STC_RESULTS_DIR = os.path.join(ROOT_DIR, "Results")
393 # The prefix for the CSV results file
395 TRAFFICGEN_STC_CSV_RESULTS_FILE_PREFIX = "RFC2544_tput"
396 # The number of trials to execute during the test
398 TRAFFICGEN_STC_NUMBER_OF_TRIALS = "1"
400 # The duration of each trial executed during the test, in seconds
401 TRAFFICGEN_STC_TRIAL_DURATION_SEC = "60"
403 # The traffic pattern between endpoints, BACKBONE, MESH or PAIR
404 TRAFFICGEN_STC_TRAFFIC_PATTERN = "PAIR"
406 # The search mode used to find the throughput rate, COMBO, STEP or BINARY
407 TRAFFICGEN_STC_SEARCH_MODE = "BINARY"
409 # The learning mode used during the test, AUTO, L2_LEARNING, L3_LERNING, or NONE
410 TRAFFICGEN_STC_LEARNING_MODE = "AUTO"
412 # The minimum percent line rate that will be used during the test
413 TRAFFICGEN_STC_RATE_LOWER_LIMIT_PCT = "1.0"
415 # The maximum percent line rate that will be used during the test
416 TRAFFICGEN_STC_RATE_UPPER_LIMIT_PCT = "99.0"
418 # If SearchMode is BINARY, the percent line rate that will be used at the start of the test
419 TRAFFICGEN_STC_RATE_INITIAL_PCT = "99.0"
421 # When SearchMode is STEP, the percent increase in load per step
422 TRAFFICGEN_STC_RATE_STEP_PCT = "10.0"
424 # The minimum percentage of load adjustment between iterations
425 TRAFFICGEN_STC_RESOLUTION_PCT = "1.0"
427 # The frame size, in bytes
428 TRAFFICGEN_STC_FRAME_SIZE = "256"
430 # The maximum acceptable frame loss percent in any iteration
431 TRAFFICGEN_STC_ACCEPTABLE_FRAME_LOSS_PCT = "0.0"
433 # The address to assign to the first emulated device interface on the first east port
434 TRAFFICGEN_STC_EAST_INTF_ADDR = ""
436 # The gateway address to assign to the first emulated device interface on the first east port
437 TRAFFICGEN_STC_EAST_INTF_GATEWAY_ADDR = ""
439 # The address to assign to the first emulated device interface on the first west port
440 TRAFFICGEN_STC_WEST_INTF_ADDR = ""
442 # The gateway address to assign to the first emulated device interface on the first west port
443 TRAFFICGEN_STC_WEST_INTF_GATEWAY_ADDR = ""
445 # Print additional information to the terminal during the test
446 TRAFFICGEN_STC_VERBOSE = "True"
448 # Spirent TestCenter Configuration -- END
449 #########################################
451 #############################
452 # Xena Configuration -- BEGIN
454 # Xena traffic generator connection info
455 TRAFFICGEN_XENA_IP = ''
456 TRAFFICGEN_XENA_PORT1 = ''
457 TRAFFICGEN_XENA_PORT2 = ''
458 TRAFFICGEN_XENA_USER = ''
459 TRAFFICGEN_XENA_PASSWORD = ''
460 TRAFFICGEN_XENA_MODULE1 = ''
461 TRAFFICGEN_XENA_MODULE2 = ''
464 TRAFFICGEN_XENA_PORT0_IP = '192.168.199.10'
465 TRAFFICGEN_XENA_PORT0_CIDR = 24
466 TRAFFICGEN_XENA_PORT0_GATEWAY = '192.168.199.1'
467 TRAFFICGEN_XENA_PORT1_IP = '192.168.199.11'
468 TRAFFICGEN_XENA_PORT1_CIDR = 24
469 TRAFFICGEN_XENA_PORT1_GATEWAY = '192.168.199.1'
471 # Xena RFC 2544 options
472 # Please reference xena documentation before making changes to these settings
473 TRAFFICGEN_XENA_2544_TPUT_INIT_VALUE = '10.0'
474 TRAFFICGEN_XENA_2544_TPUT_MIN_VALUE = '0.1'
475 TRAFFICGEN_XENA_2544_TPUT_MAX_VALUE = '100.0'
476 TRAFFICGEN_XENA_2544_TPUT_VALUE_RESOLUTION = '0.5'
477 TRAFFICGEN_XENA_2544_TPUT_USEPASS_THRESHHOLD = 'false'
478 TRAFFICGEN_XENA_2544_TPUT_PASS_THRESHHOLD = '0.0'
480 # Xena RFC 2544 final verification options
481 TRAFFICGEN_XENA_RFC2544_VERIFY = False
482 TRAFFICGEN_XENA_RFC2544_VERIFY_DURATION = 120 # in seconds
483 # Number of verify attempts before giving up...
484 TRAFFICGEN_XENA_RFC2544_MAXIMUM_VERIFY_ATTEMPTS = 10
485 # Logic for restarting binary search, see documentation for details
486 TRAFFICGEN_XENA_RFC2544_BINARY_RESTART_SMART_SEARCH = True
488 # Xena Continuous traffic options
489 # Please reference xena documentation before making changes to these settings
490 TRAFFICGEN_XENA_CONT_PORT_LEARNING_ENABLED = True
491 TRAFFICGEN_XENA_CONT_PORT_LEARNING_DURATION = 3
493 # Xena Configuration -- END
494 ###########################
496 ###################################################
497 # MoonGen Configuration and Connection Info-- BEGIN
499 # Ex: TRAFFICGEN_MOONGEN_HOST_IP_ADDR = "192.10.1.1"
500 TRAFFICGEN_MOONGEN_HOST_IP_ADDR = ''
501 TRAFFICGEN_MOONGEN_USER = ''
502 TRAFFICGEN_MOONGEN_BASE_DIR = ''
503 TRAFFICGEN_MOONGEN_PORTS = ''
504 # Ex. 10 Gbps: TRAFFICGEN_MOONGEN_LINE_SPEED_GBPS = '10'
505 # Today only 10 Gbps is supported
506 TRAFFICGEN_MOONGEN_LINE_SPEED_GBPS = ''
508 # MoonGen Configuration and Connection Info-- END
509 #################################################
511 ################################################
512 # Trex Configuration and Connection Info-- BEGIN
514 # Example: TRAFFICGEN_TREX_HOST_IP_ADDR = "192.10.1.1"
515 # Example: TRAFFICGEN_TREX_USER = 'root'
516 # Example: TRAFFICGEN_TREX_BASE_DIR = '/traffic_gen/trex/'
517 # Example: TRAFFICGEN_TREX_PORT1 = '00:00:00:00:00:00'
518 TRAFFICGEN_TREX_HOST_IP_ADDR = ''
519 TRAFFICGEN_TREX_USER = ''
520 TRAFFICGEN_TREX_BASE_DIR = ''
521 TRAFFICGEN_TREX_PORT1 = ''
522 TRAFFICGEN_TREX_PORT2 = ''
523 # RFC2544 Throughput execution will end after threshold below is reached.
524 # It defines maximal difference between frame rate of successful (i.e. defined
525 # frameloss reached) and unsuccessful (i.e. frameloss exceeded) iterations.
526 TRAFFICGEN_TREX_RFC2544_TPUT_THRESHOLD = 0.05
527 # Latency statistics are collected by separate stream created for each interface.
528 # Parameter below defines frequency of packets used for latency measurement in PPS.
529 # Value 0 will disable latency specific streams.
530 TRAFFICGEN_TREX_LATENCY_PPS = 1000
531 # Enablement of learning packets before sending test traffic
532 TRAFFICGEN_TREX_LEARNING_MODE = True
533 TRAFFICGEN_TREX_LEARNING_DURATION = 5
534 # FOR SR-IOV or multistream layer 2 tests to work with T-Rex enable Promiscuous mode
535 TRAFFICGEN_TREX_PROMISCUOUS = False
536 # Enable below options to force T-rex api to attempt to use speed specified on server
537 # side when pushing traffic. For 40G use 40000. For 25G use 25000.
538 TRAFFICGEN_TREX_FORCE_PORT_SPEED = False
539 TRAFFICGEN_TREX_PORT_SPEED = 10000 # 10G
541 PATHS['trafficgen'] = {
545 'path': os.path.join(ROOT_DIR, 'src/trex/trex/scripts/automation/trex_control_plane/stl')
549 # TRex validation option for RFC2544
550 TRAFFICGEN_TREX_VERIFICATION_MODE = False
551 TRAFFICGEN_TREX_VERIFICATION_DURATION = 60
552 TRAFFICGEN_TREX_MAXIMUM_VERIFICATION_TRIALS = 10
553 # TREX Configuration and Connection Info-- END
554 ##############################################