1 # Copyright (c) 2019 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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """Constants used in CSIT."""
17 class Constants(object):
18 """Constants used in CSIT.
20 TODO: Yaml files are easier for humans to edit.
21 Figure out how to set the attributes by parsing a file
22 that works regardless of current working directory.
25 # OpenVPP testing directory location at topology nodes
26 REMOTE_FW_DIR = '/tmp/openvpp-testing'
28 # shell scripts location
29 RESOURCES_LIB_SH = 'resources/libraries/bash'
31 # Python API provider location
32 RESOURCES_PAPI_PROVIDER = 'resources/tools/papi/vpp_papi_provider.py'
34 # vat templates location
35 RESOURCES_TPL_VAT = 'resources/templates/vat'
37 # Kubernetes templates location
38 RESOURCES_TPL_K8S = 'resources/templates/kubernetes'
40 # KernelVM templates location
41 RESOURCES_TPL_VM = 'resources/templates/vm'
43 # Container templates location
44 RESOURCES_TPL_CONTAINER = 'resources/templates/container'
46 # OpenVPP VAT binary name
47 VAT_BIN_NAME = 'vpp_api_test'
49 # VPP service unit name
52 # Number of system CPU cores.
55 # Number of vswitch main thread CPU cores.
59 QEMU_BIN_PATH = '/usr/bin'
61 # QEMU VM kernel image path
62 QEMU_VM_KERNEL = '/opt/boot/vmlinuz'
64 # QEMU VM nested image path
65 QEMU_VM_IMAGE = '/var/lib/vm/vhost-nested.img'
68 QEMU_VM_DPDK = '/opt/dpdk-19.02'
70 # TRex install version
71 TREX_INSTALL_VERSION = '2.54'
73 # TRex install directory
74 TREX_INSTALL_DIR = '/opt/trex-core-2.54'
76 # Honeycomb directory location at topology nodes:
77 REMOTE_HC_DIR = '/opt/honeycomb'
79 # Honeycomb persistence files location
80 REMOTE_HC_PERSIST = '/var/lib/honeycomb/persist'
82 # Honeycomb log file location
83 REMOTE_HC_LOG = '/var/log/honeycomb/honeycomb.log'
85 # Honeycomb templates location
86 RESOURCES_TPL_HC = 'resources/templates/honeycomb'
88 # ODL Client Restconf listener port
91 # Sysctl kernel.core_pattern
92 KERNEL_CORE_PATTERN = '/tmp/%p-%u-%g-%s-%t-%h-%e.core'
95 CORE_DUMP_DIR = '/tmp'
97 # Equivalent to ~0 used in vpp code
98 BITWISE_NON_ZERO = 0xffffffff
100 # Maximum number of API calls per PapiExecutor execution
101 PAPI_MAX_API_BULK = 250
103 # Mapping from NIC name to its bps limit.
104 # TODO: Implement logic to lower limits to TG NIC or software. Or PCI.
105 NIC_NAME_TO_LIMIT = {
106 # TODO: Explain why ~40Gbps NICs are using ~25Gbps limit.
107 "Cisco-VIC-1227": 10000000000,
108 "Cisco-VIC-1385": 24500000000,
109 "Intel-X520-DA2": 10000000000,
110 "Intel-X553": 10000000000,
111 "Intel-X710": 10000000000,
112 "Intel-XL710": 24500000000,
113 "Intel-XXV710": 24500000000,
116 # Suite file names use somewhat more rich (less readable) codes for NICs.
118 "Cisco-VIC-1227": "10ge2p1vic1227",
119 "Cisco-VIC-1385": "40ge2p1vic1385",
120 "Intel-X520-DA2": "10ge2p1x520",
121 "Intel-X553": "10ge2p1x553",
122 "Intel-X710": "10ge2p1x710",
123 "Intel-XL710": "40ge2p1xl710",
124 "Intel-XXV710": "25ge2p1xxv710",
127 # TODO CSIT-1481: Crypto HW should be read from topology file instead.
128 NIC_NAME_TO_CRYPTO_HW = {
129 "Intel-X553": "HW_C3xxx",
130 "Intel-X710": "HW_DH895xcc",
131 "Intel-XL710": "HW_DH895xcc",
134 PERF_TYPE_TO_KEYWORD = {
135 "mrr": "Traffic should pass with maximum rate",
136 "ndrpdr": "Find NDR and PDR intervals using optimized search",
137 "soak": "Find critical load using PLRsearch",
140 PERF_TYPE_TO_SUITE_DOC_VER = {
141 "mrr" : '''fication:* In MaxReceivedRate tests TG sends traffic\\
142 | ... | at line rate and reports total received packets over trial period.\\''',
143 # TODO: Figure out how to include the full "*[Ver] TG verification:*"
144 # while keeping this readable and without breaking line length limit.
145 "ndrpdr": '''fication:* TG finds and reports throughput NDR (Non Drop\\
146 | ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
147 | ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
148 | ... | of packets transmitted. NDR and PDR are discovered for different\\
149 | ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
150 "soak": '''fication:* TG sends traffic at dynamically computed\\
151 | ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
152 | ... | of a rate at which a prescribed small fraction of packets\\
153 | ... | would be lost. After set time, the serarch stops\\
154 | ... | and the algorithm reports its current estimate.\\''',
157 PERF_TYPE_TO_TEMPLATE_DOC_VER = {
158 "mrr": '''Measure MaxReceivedRate for ${frame_size}B frames\\
159 | | ... | using burst trials throughput test.\\''',
160 "ndrpdr": '''Measure NDR and PDR values using MLRsearch algorithm.\\''',
161 "soak": '''Estimate critical rate using PLRsearch algorithm.\\''',