Update of VPP_STABLE_VER files + quick fix for gre create tunnel
[csit.git] / resources / libraries / python / Constants.py
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:
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 """Constants used in CSIT."""
15
16
17 class Constants(object):
18     """Constants used in CSIT.
19
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.
23     """
24
25     # OpenVPP testing directory location at topology nodes
26     REMOTE_FW_DIR = '/tmp/openvpp-testing'
27
28     # shell scripts location
29     RESOURCES_LIB_SH = 'resources/libraries/bash'
30
31     # Python API provider location
32     RESOURCES_PAPI_PROVIDER = 'resources/tools/papi/vpp_papi_provider.py'
33
34     # vat templates location
35     RESOURCES_TPL_VAT = 'resources/templates/vat'
36
37     # Kubernetes templates location
38     RESOURCES_TPL_K8S = 'resources/templates/kubernetes'
39
40     # KernelVM templates location
41     RESOURCES_TPL_VM = 'resources/templates/vm'
42
43     # OpenVPP VAT binary name
44     VAT_BIN_NAME = 'vpp_api_test'
45
46     # VPP service unit name
47     VPP_UNIT = 'vpp'
48
49     # Number of system CPU cores.
50     CPU_CNT_SYSTEM = 1
51
52     # Number of vswitch main thread CPU cores.
53     CPU_CNT_MAIN = 1
54
55     # QEMU binary path
56     QEMU_BIN_PATH = '/usr/bin'
57
58     # QEMU VM kernel image path
59     QEMU_VM_KERNEL = '/opt/boot/vmlinuz'
60
61     # QEMU VM nested image path
62     QEMU_VM_IMAGE = '/var/lib/vm/vhost-nested.img'
63
64     # QEMU VM DPDK path
65     QEMU_VM_DPDK = '/opt/dpdk-19.02'
66
67     # TRex install version
68     TREX_INSTALL_VERSION = '2.35'
69
70     # TRex install directory
71     TREX_INSTALL_DIR = '/opt/trex-core-2.35'
72
73     # Honeycomb directory location at topology nodes:
74     REMOTE_HC_DIR = '/opt/honeycomb'
75
76     # Honeycomb persistence files location
77     REMOTE_HC_PERSIST = '/var/lib/honeycomb/persist'
78
79     # Honeycomb log file location
80     REMOTE_HC_LOG = '/var/log/honeycomb/honeycomb.log'
81
82     # Honeycomb templates location
83     RESOURCES_TPL_HC = 'resources/templates/honeycomb'
84
85     # ODL Client Restconf listener port
86     ODL_PORT = 8181
87
88     # Sysctl kernel.core_pattern
89     KERNEL_CORE_PATTERN = '/tmp/%p-%u-%g-%s-%t-%h-%e.core'
90
91     # Core dump directory
92     CORE_DUMP_DIR = '/tmp'
93
94     # Equivalent to ~0 used in vpp code
95     BITWISE_NON_ZERO = 0xffffffff
96
97     # Mapping from NIC name to its bps limit.
98     # TODO: Implement logic to lower limits to TG NIC or software. Or PCI.
99     NIC_NAME_TO_LIMIT = {
100         # TODO: Explain why ~40Gbps NICs are using ~25Gbps limit.
101         "Cisco-VIC-1227": 10000000000,
102         "Cisco-VIC-1385": 24500000000,
103         "Intel-X520-DA2": 10000000000,
104         "Intel-X553": 10000000000,
105         "Intel-X710": 10000000000,
106         "Intel-XL710": 24500000000,
107         "Intel-XXV710": 24500000000,
108     }
109
110     # Suite file names use somewhat more rich (less readable) codes for NICs.
111     NIC_NAME_TO_CODE = {
112         "Cisco-VIC-1227": "10ge2p1vic1227",
113         "Cisco-VIC-1385": "40ge2p1vic1385",
114         "Intel-X520-DA2": "10ge2p1x520",
115         "Intel-X553": "10ge2p1x553",
116         "Intel-X710": "10ge2p1x710",
117         "Intel-XL710": "40ge2p1xl710",
118         "Intel-XXV710": "25ge2p1xxv710",
119     }
120
121     # TODO CSIT-1481: Crypto HW should be read from topology file instead.
122     NIC_NAME_TO_CRYPTO_HW = {
123         "Intel-X553": "HW_C3xxx",
124         "Intel-X710": "HW_DH895xcc",
125         "Intel-XL710": "HW_DH895xcc",
126     }
127
128     PERF_TYPE_TO_KEYWORD = {
129         "mrr": "Traffic should pass with maximum rate",
130         "ndrpdr": "Find NDR and PDR intervals using optimized search",
131         "soak": "Find critical load using PLRsearch",
132     }
133
134     PERF_TYPE_TO_SUITE_DOC_VER = {
135         "mrr" : '''fication:* In MaxReceivedRate tests TG sends traffic\\
136 | ... | at line rate and reports total received packets over trial period.\\''',
137         # TODO: Figure out how to include the full "*[Ver] TG verification:*"
138         # while keeping this readable and without breaking line length limit.
139         "ndrpdr": '''fication:* TG finds and reports throughput NDR (Non Drop\\
140 | ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
141 | ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
142 | ... | of packets transmitted. NDR and PDR are discovered for different\\
143 | ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
144         "soak": '''fication:* TG sends traffic at dynamically computed\\
145 | ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
146 | ... | of a rate at which a prescribed small fraction of packets\\
147 | ... | would be lost. After set time, the serarch stops\\
148 | ... | and the algorithm reports its current estimate.\\''',
149     }
150
151     PERF_TYPE_TO_TEMPLATE_DOC_VER = {
152         "mrr": '''Measure MaxReceivedRate for ${frame_size}B frames\\
153 | | ... | using burst trials throughput test.\\''',
154         "ndrpdr": '''Measure NDR and PDR values using MLRsearch algorithm.\\''',
155         "soak": '''Estimate critical rate using PLRsearch algorithm.\\''',
156     }