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 # OpenVPP VAT binary name
38 VAT_BIN_NAME = 'vpp_api_test'
40 # VPP service unit name
44 QEMU_BIN_PATH = '/usr/bin'
46 # QEMU VM kernel image path
47 QEMU_VM_KERNEL = '/opt/boot/vmlinuz'
49 # QEMU VM nested image path
50 QEMU_VM_IMAGE = '/var/lib/vm/vhost-nested.img'
53 QEMU_VM_DPDK = '/opt/dpdk-19.02'
55 # TRex install version
56 TREX_INSTALL_VERSION = '2.35'
58 # TRex install directory
59 TREX_INSTALL_DIR = '/opt/trex-core-2.35'
61 # Kubernetes templates location
62 RESOURCES_TPL_K8S = 'resources/templates/kubernetes'
64 # KernelVM templates location
65 RESOURCES_TPL_VM = 'resources/templates/vm'
67 # Honeycomb directory location at topology nodes:
68 REMOTE_HC_DIR = '/opt/honeycomb'
70 # Honeycomb persistence files location
71 REMOTE_HC_PERSIST = '/var/lib/honeycomb/persist'
73 # Honeycomb log file location
74 REMOTE_HC_LOG = '/var/log/honeycomb/honeycomb.log'
76 # Honeycomb templates location
77 RESOURCES_TPL_HC = 'resources/templates/honeycomb'
79 # ODL Client Restconf listener port
82 # Sysctl kernel.core_pattern
83 KERNEL_CORE_PATTERN = '/tmp/%p-%u-%g-%s-%t-%h-%e.core'
86 CORE_DUMP_DIR = '/tmp'
88 # Mapping from NIC name to its bps limit.
89 # TODO: Implement logic to lower limits to TG NIC or software. Or PCI.
91 # TODO: Explain why ~40Gbps NICs are using ~25Gbps limit.
92 "Cisco-VIC-1227": 10000000000,
93 "Cisco-VIC-1385": 24500000000,
94 "Intel-X520-DA2": 10000000000,
95 "Intel-X553": 10000000000,
96 "Intel-X710": 10000000000,
97 "Intel-XL710": 24500000000,
98 "Intel-XXV710": 24500000000,
101 # Suite file names use somewhat more rich (less readable) codes for NICs.
103 "Cisco-VIC-1227": "10ge2p1vic1227",
104 "Cisco-VIC-1385": "40ge2p1vic1385",
105 "Intel-X520-DA2": "10ge2p1x520",
106 "Intel-X553": "10ge2p1x553",
107 "Intel-X710": "10ge2p1x710",
108 "Intel-XL710": "40ge2p1xl710",
109 "Intel-XXV710": "25ge2p1xxv710",
112 # TODO CSIT-1481: Crypto HW should be read from topology file instead.
113 NIC_NAME_TO_CRYPTO_HW = {
114 "Intel-X553": "HW_C3xxx",
115 "Intel-X710": "HW_DH895xcc",
116 "Intel-XL710": "HW_DH895xcc",
119 PERF_TYPE_TO_KEYWORD = {
120 "mrr": "Traffic should pass with maximum rate",
121 "ndrpdr": "Find NDR and PDR intervals using optimized search",
122 "soak": "Find critical load using PLRsearch",
125 PERF_TYPE_TO_SUITE_DOC_VER = {
126 "mrr" : '''fication:* In MaxReceivedRate tests TG sends traffic\\
127 | ... | at line rate and reports total received packets over trial period.\\''',
128 # TODO: Figure out how to include the full "*[Ver] TG verification:*"
129 # while keeping this readable and without breaking line length limit.
130 "ndrpdr": '''fication:* TG finds and reports throughput NDR (Non Drop\\
131 | ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
132 | ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
133 | ... | of packets transmitted. NDR and PDR are discovered for different\\
134 | ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
135 "soak": '''fication:* TG sends traffic at dynamically computed\\
136 | ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
137 | ... | of a rate at which a prescribed small fraction of packets\\
138 | ... | would be lost. After set time, the serarch stops\\
139 | ... | and the algorithm reports its current estimate.\\''',
142 PERF_TYPE_TO_TEMPLATE_DOC_VER = {
143 "mrr": '''Measure MaxReceivedRate for ${frame_size}B frames\\
144 | | ... | using burst trials throughput test.\\''',
145 "ndrpdr": '''Measure NDR and PDR values using MLRsearch algorithm.\\''',
146 "soak": '''Estimate critical rate using PLRsearch algorithm.\\''',